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

Show:

inherited

Classes
- \eoxia\User_Class

Table of Contents

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

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

\eoxia\User_Class
jump to top

Package: EO_Framework\EO_Model\Class

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

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

Properties

string $base = 'user'

Slug de base pour la route dans l'api rest

Default value'user'Details

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

string $base = ''

Le slug de base de l'objet actuel.

Default value''Details

Type: string

array $capabilities = array('get' => 'list_users', 'put' => 'edit_users', 'post' => 'edit_users', 'delete' => 'delete_users')

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

Default valuearray('get' => 'list_users', 'put' => 'edit_users', 'post' => 'edit_users', 'delete' => 'delete_users')Details

Type: array

string $element_prefix = 'U'

Utiles pour DigiRisk

Default value'U'Details

Type: string
Todo: Rien à faire ici

string $identifier_helper = 'user'

Utiles pour récupérer la clé unique

Default value'user'Details

Type: string
Inherited_from: \eoxia\Object_Class::$identifier_helper
Todo: Rien à faire ici
Todo: Expliquer la documentation

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 = '_wpeo_user'

La clé principale pour post_meta

Default value'_wpeo_user'Details

Type: string
Inherited_from: \eoxia\Object_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\User_Model'

Le nom du modèle

Default value'\eoxia\User_Model'Details

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

string $model_name = ''

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

Default value''Details

Type: string

string $type = 'user'

User element type

Default value'user'Details

Type: string
Inherited_from: \eoxia\Object_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

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_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) : \eoxia\Comment_Model

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

Parameters

Name	Type	Description
$args	array	Les paramètres de WP_User_Query @see https://codex.wordpress.org/Class_Reference/WP_User_Query.
$single	boolean	Si on veut récupérer un tableau, ou qu'une seule entrée.

Returns

Type	Description
\eoxia\Comment_Model

Details

Since: 0.1.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_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

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

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

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

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\user.class.php

\eoxia\User_Classjump to top

Properties

Methods

\eoxia\User_Class
jump to top