modules\wpeo-model\class\attachment.class.php

Show:

inherited

Classes
- \eoxia\Attachment_Class

Table of Contents

Gestion des attachments (POST, PUT, GET, DELETE)

Author: Eoxia
Copyright: 2015-2018
Package: EO_Framework\EO_Model\Class
Since: 1.0.0
Version: 1.0.0

\eoxia\Attachment_Class
jump to top

Package: EO_Framework\EO_Model\Class

Gestion des attachments (POST, PUT, GET, DELETE)

Parent(s): \eoxia\Post_Class < \eoxia\Object_Class < \eoxia\Rest_Class < \eoxia\Singleton_Util
Inherited_from: \eoxia\Post_Class

Properties

string $attached_taxonomy_type = 'attachment_category'

Nom de la taxonomy

Default value'attachment_category'Details

Type: string

string $base = 'eo-attachment'

Le type du post

Default value'eo-attachment'Details

Type: string
Inherited_from: \eoxia\Post_Class::$base

string $base = ''

Le slug de base de l'objet actuel.

Default value''Details

Type: string

array $capabilities = array('get' => 'read', 'put' => 'edit_posts', 'post' => 'edit_posts', 'delete' => 'delete_posts')

La liste des droits a avoir pour accèder aux différentes méthodes

Default valuearray('get' => 'read', 'put' => 'edit_posts', 'post' => 'edit_posts', 'delete' => 'delete_posts')Details

Type: array

string $identifier_helper = 'attachment'

Utiles pour récupérer la clé unique

Default value'attachment'Details

Type: string
Inherited_from: \eoxia\Post_Class::$identifier_helper
Todo: Rien à faire ici

string $identifier_helper = ''

Utiles pour récupérer la clé unique

Default value''Details

Type: string

\eoxia\Singleton_Util $instance

static

L'instance courant du singleton

Details

Type: \eoxia\Singleton_Util

string $meta_key = 'eo_attachment'

La clé principale pour post_meta

Default value'eo_attachment'Details

Type: string
Inherited_from: \eoxia\Post_Class::$meta_key

string $meta_key = ''

La clé principale pour la méta de l'objet.

Default value''Details

Type: string

string $model_name = '\eoxia\Attachment_Model'

Le nom du modèle

Default value'\eoxia\Attachment_Model'Details

Type: string
Inherited_from: \eoxia\Post_Class::$model_name

string $model_name = ''

Le nom du modèle pour l'objet actuel.

Default value''Details

Type: string

string $model_path = ''

Le chemin vers le modèle

Default value''Details

Type: string

string $post_type_name = 'Attachments'

Le nom pour le resgister post type

Default value'Attachments'Details

Type: string
Inherited_from: \eoxia\Post_Class::$post_type_name

string $post_type_name = 'posts'

Le nom pour le resgister post type

Default value'posts'Details

Type: string

string $type = 'attachment'

Le type du post

Default value'attachment'Details

Type: string
Inherited_from: \eoxia\Post_Class::$type

string $type = ''

Le type de l'objet actuel.

Default value''Details

Type: string

Methods

__construct() : void

finalinherited

Appelle le constructeur parent

Inherited from:

Details

Since: 0.1.0
Version: 1.0.0

check_cap(string $cap) : string

inherited

Check user capability to access to element

Inherited from:

Parameters

Name	Type	Description
$cap	string	The capability name to check.

Returns

Type	Description
string	The rest api base for current element

Details

Since: 1.0.0
Version: 1.0.0

check_file(\eoxia\Document_Model $document) : array

Vérification de l'existence d'un fichier à partir de la définition d'un document.

1- On remplace l'url du site "site_url( '/' )" par le chemin "ABSPATH" contenant les fichiers du site: on vérifie si le fichier existe. 2- Si le fichier n'existe pas: 2.a- On récupère la meta associée automatiqumeent par WordPress. 2.b- Si la méta n'est pas vide, on vérifie que sa valeur concaténée au chemin absolu des uploads "wp_upload_dir()" de WordPress soit bien un fichier

Parameters

Name	Type	Description
$document	\eoxia\Document_Model	La définition du document à vérifier.

Returns

Type	Description
array	Tableau avec le status d'existence du fichier (True/False) et le lien de téléchargement du fichier.

Details

Since: 1.0.0
Version: 1.0.0

construct() : void

abstractinherited

Le constructeur pour les enfants

Inherited from:

Details

Since: 0.1.0
Version: 1.0.0

create(Array $data) : Object

inherited

Appelle la méthode update puis renvoies l'objet mis à jour ou créé.

Inherited from:

Parameters

Name	Type	Description
$data	Array	Les données.

Returns

Type	Description
Object	L'objet avec toutes ses données.

Details

Since: 0.1.0
Version: 1.0.0

create_document(object $element, array $types, array $document_meta, string $extension = 'odt') : array

Création du document dans la base de données puis appel de la fonction de génération du fichier

Parameters

Name	Type	Description
$element	object	L'élément parent ou le document sera attaché.
$types	array	Les catégories auxquelles associer le document généré.
$document_meta	array	Les données a écrire dans le modèle de document.
$extension	string	L'extension à utiliser.

Returns

Type	Description
array	Le résultat de la création du document.

Details

Since: 1.0.0
Version: 1.0.0

create_from_parent(\eoxia\WP_Http::request $request) : mixed

inherited

Create / Update element from request

Inherited from:

Parameters

Name	Type	Description
$request	\eoxia\WP_Http::request	The current Rest API request.

Returns

Type	Description
mixed	New created element.

Details

Since: 1.6.0
Version: 1.6.0

g() : \eoxia\Singleton_Util

staticfinalinherited

Récupères l'instance courante

Inherited from:

Returns

Type	Description
\eoxia\Singleton_Util	L'instance courante

Details

Since: 0.1.0
Version: 1.0.0

get(array $args = array(), boolean $single = false) : Object

inherited

Récupères les données selon le modèle défini.

Inherited from:

Parameters

Name	Type	Description
$args	array	Les paramètres à appliquer pour la récupération @see https://codex.wordpress.org/Function_Reference/WP_Query.
$single	boolean	Si on veut récupérer un tableau, ou qu'une seule entrée.

Returns

Type	Description
Object

Details

Since: 1.0.0
Version: 1.0.0

get_attached_taxonomy() : string

inherited

Retournes le nom de la catégorie attachée au post.

Inherited from:

Returns

Type	Description
string	Le nom de la catégorie.

Details

Since: 1.0.0
Version: 1.0.0

get_dir_path(string $path_type = 'basedir') : string

Récupères le chemin vers le dossier frais-pro dans wp-content/uploads

Parameters

Name	Type	Description
$path_type	string	(Optional) Le type de path.

Returns

Type	Description
string	Le chemin vers le document

get_document_type_next_revision(array $types, integer $element_id) : integer

Récupération de la prochaine version pour un type de document

Parameters

Name	Type	Description
$types	array	Les catégories du document.
$element_id	integer	L'ID de l'élément.

Returns

Type	Description
integer	La version +1 du document actuellement en cours de création.

Details

Since: 1.0.0
Version: 1.0.0

get_from_parent(\eoxia\WP_Http::request $request) : mixed

inherited

Get element(s) from parent object type

Inherited from:

Parameters

Name	Type	Description
$request	\eoxia\WP_Http::request	The current Rest API request.

Returns

Type	Description
mixed	Element list or single element if id was specified.

Details

Since: 1.0.0
Version: 1.0.0

get_identifier_helper() : string

inherited

Utile uniquement pour DigiRisk.

Inherited from:

Returns

Type	Description
string	L'identifiant des commentaires pour DigiRisk.

Details

Since: 1.0.0
Version: 1.0.0

get_meta_key() : string

inherited

Retourne le nom de la méta générale de l'objet actuel.

Inherited from:

Returns

Type	Description
string	Le nom de la méta de l'objet actuel

Details

Since: 1.0.0
Version: 1.0.0

get_model_for_element(array $current_element_type, string $extension = 'odt') : array

Récupération de la liste des modèles de fichiers disponible pour un type d'élément

Parameters

Name	Type	Description
$current_element_type	array	La liste des types pour lesquels il faut récupérer les modèles de documents.
$extension	string	L'extension à utilisé.

Returns

Type	Description
array	Un statut pour la réponse, un message si une erreur est survenue, le ou les identifiants des modèles si existants.

Details

Since: 1.0.0
Version: 1.0.0

get_parent_from_parent(\eoxia\WP_Http::request $request) : mixed

inherited

Get element(s) from parent object type

Inherited from:

Parameters

Name	Type	Description
$request	\eoxia\WP_Http::request	The current Rest API request.

Returns

Type	Description
mixed	Element list or single element if id was specified.

Details

Since: 1.0.0
Version: 1.0.0

get_rest_base() : string

inherited

Return the base for rest api.

Inherited from:

Returns

Type	Description
string	The rest api base for current element

Details

Since: 1.0.0
Version: 1.0.0

get_schema() : Object

inherited

Permet de récupérer le schéma avec les données du modèle par défault.

Inherited from:

Returns

Type	Description
Object

Details

Since: 0.1.0
Version: 1.0.0

get_type() : string

inherited

Retourne le post type.

Inherited from:

Returns

Type	Description
string	Le type de l'objet actuel

Details

Since: 1.0.0
Version: 1.0.0

init_post_type() : boolean

inherited

Initialise le post type selon $name et $name_singular.

Inherited from:

Initialise la taxonomy si elle existe.

Returns

Type	Description
boolean

Details

See
Since: 1.0.0
Version: 1.0.0

prepare_items_for_response(array $object_list, string $wp_type, string $meta_key, string $object_id_field) : array

inherited

Factorisation de la fonction de construction des objets après un GET.

Inherited from:

Parameters

Name	Type	Description
$object_list	array	La liste des objets récupérés.
$wp_type	string	Le type de l'élément actuel en cours de traitement.
$meta_key	string	La clé de la métadonnée principale que l'on a défini pour l'objet.
$object_id_field	string	la clé primaire permettant d'identifier l'objet.

Returns

Type	Description
array	La liste des objets construits selon le modèle défini.

register_routes() : void

inherited

Défini et ajoute les routes dans l'api rest de WordPress

Inherited from:

Details

Since: 1.0.0
Version: 1.0.0

search(string $search, array $array) : array

inherited

Recherche dans les meta value.

Inherited from:

Parameters

Name	Type	Description
$search	string	Le terme de la recherche.
$array	array	La définition de la recherche.

Returns

Type	Description
array

Details

Since: 1.0.0
Version: 1.0.0

set_model(string $model_name) : void

inherited

Permet de changer le modèle en dur.

Inherited from:

Parameters

Name	Type	Description
$model_name	string	Le nom du modèle.

Details

Since: 1.0.0
Version: 1.3.6.0

update(Array $data) : Object

inherited

Insère ou met à jour les données dans la base de donnée.

Inherited from:

Parameters

Name	Type	Description
$data	Array	Les données a insérer ou à mêttre à jour.

Returns

Type	Description
Object	L'objet construit grâce au modèle.

Details

Since: 0.1.0
Version: 1.0.0

modules\wpeo-model\class\attachment.class.php

\eoxia\Attachment_Classjump to top

Properties

Methods

\eoxia\Attachment_Class
jump to top