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

Show: PublicProtectedPrivateinherited
Table of Contents
Gestion de la construction des données selon les modèles.
Author
Eoxia  
Copyright
2015-2018  
Package
EO_Framework\EO_Model\Class  
Since
0.1.0  
Version
1.0.0  

\eoxia\Data_Class

Package: EO_Framework\EO_Model\Class
Gestion de la construction des données selon les modèles.
Parent(s)
\eoxia\Helper_Class
Children
\eoxia\Comment_Model
\eoxia\Post_Model
\eoxia\Term_Model
\eoxia\User_Model
Inherited_from
\eoxia\Helper_Class  

Properties

>VPropertypublicarray $accepted_types = array()
static
La liste complétes des types de champs acceptés pour les champs dans EO_Framework.
Default valuearray()Details
Type
array
>VPropertypublicarray $built_in_types = array('string', 'integer', 'float', 'boolean', 'array')
static
La liste des types de base dans PHP acceptés par EO_Framework pour les champs.
Default valuearray('string', 'integer', 'float', 'boolean', 'array')Details
Type
array
>VPropertypublicarray $custom_types = array('wpeo_date')
static
La liste des types de personnalisés acceptés par EO_Framework pour les champs.
Default valuearray('wpeo_date')Details
Type
array
>VPropertyprivatestring $req_method
Variable contenant la méthode actuellement utilisée. Permet de construire l'objet demandé selon la méthode HTTP utilisée.
Details
Type
string
>VPropertyprivate\eoxia\WP_Error $wp_errors
Variable contenant l'ensemble des erreurs rencontrées lors de la création d'un objet.
Details
Type
\eoxia\WP_Error

Methods

methodpublic__construct(Array $data = null, string $req_method) : void

Appelle la méthode pour dispatcher les données.

Parameters
NameTypeDescription
$dataArray

Les données non traité. Peut être null, permet de récupérer le schéma.

$req_methodstring

La méthode HTTP actuellement utilisée.

Details
Since
1.0.0  
Version
1.0.0  
methodpublic__toString() : string
inherited

Permet de faire echo sur un objet et supprimes la définition du modèle avant l'affichage.

Inherited from:
Returns
TypeDescription
stringvoid
methodpubliccheck_value_type(mixed $value, string $field_name, array $field_def) : void

Vérification du type de la valeur d'un champs. Si le type n'est pas correct on rempli la variable $this->wp_errors qui sera retournée en fin de traitement.

Parameters
NameTypeDescription
$valuemixed

La valeur du champs à vérifier.

$field_namestring

Le nom du champs à vérifier. Utilisé pour le message d'erreur.

$field_defarray

La définition complète du champs à vérifier.

methodpublicconvert_to_wordpress() : array

Convertis le modèle en un tableau compatible WordPress.

Returns
TypeDescription
arrayTableau compatible avec les fonctions WordPress.
Details
Since
1.0.0  
Version
1.0.0  
methodprivatedelete_model_for_print(object $current) : void
inherited

Supprime le modèle.

Inherited from:
Parameters
NameTypeDescription
$currentobject

L'objet complet.

Details
Since
1.0.0  
Version
1.0.0  
methodpublicget_class() : string
inherited

Récupères le nom de la classe selon le model.

Inherited from:
Returns
TypeDescription
stringLe nom de la classe avec le namespace si existant.
Details
Since
1.0.0  
Version
1.0.0  
methodpublicget_model() : Object
inherited

Récupères le modèle.

Inherited from:
Returns
TypeDescription
Objectle modèle.
Details
Since
1.0.0  
Version
1.0.0  
methodprivatehandle_data(array $data, array $schema = null) : object

Dispatches les données selon le modèle.

Parameters
NameTypeDescription
$dataarray

Les données envoyées par l'utilisateur pour construire un objet selon un schéma.

$schemaarray

Optionnal. La définition des données. Ce paramètre est utilisé uniquement dans le cas d'un schéma récursif.

Returns
TypeDescription
objectLes données traitées, typées et converties en l'objet demandé.
Details
Since
1.0.0  
Version
1.0.0  
methodpublichandle_value_type(mixed $value, array $field_def) : mixed

Forces le typage des données.

Parameters
NameTypeDescription
$valuemixed

La valeur courante.

$field_defarray

La définition du champ.

Returns
TypeDescription
mixedL'objet avec le typage forcé.
Details
Since
0.1.0  
Version
1.0.0  
methodpublicoffsetExists(string $offset) : boolean
inherited

Checks if a parameter is set.

Inherited from:
Parameters
NameTypeDescription
$offsetstring

Parameter name.

Returns
TypeDescription
booleanWhether the parameter is set.
Details
Since
1.0.0  
methodpublicoffsetGet(string $offset) : mixed | null
inherited

Retrieves a parameter from the request.

Inherited from:
Parameters
NameTypeDescription
$offsetstring

Parameter name.

Returns
TypeDescription
mixed | nullValue if set, null otherwise.
Details
Since
1.0.0  
methodpublicoffsetSet(string $offset, mixed $value) : void
inherited

Sets a parameter on the request.

Inherited from:
Parameters
NameTypeDescription
$offsetstring

Parameter name.

$valuemixed

Parameter value.

Details
Since
1.0.0  
methodpublicoffsetUnset(string $offset) : void
inherited

Removes a parameter from the request.

Inherited from:
Parameters
NameTypeDescription
$offsetstring

Parameter name.

Details
Since
1.0.0  
Documentation was generated by phpDocumentor 2.9.1.