SERVICE
Table of Contents
Functions
- noizetier_noisette_completer_description() : array<string|int, mixed>
- Complète la description fournie avec les champs propres au noiZetier, à savoir, ceux identifiant la page/composition ou l'objet et le bloc.
- noizetier_noisette_stocker() : int
- Stocke la description d'une nouvelle noisette et calcule son identifiant unique, ou met à jour les paramètres d'affichage d'une noisette existante.
- noizetier_noisette_ranger() : bool
- Positionne une noisette à un rang différent que celui qu'elle occupe dans le conteneur.
- noizetier_noisette_destocker() : bool
- Retire, de l'espace de stockage, une noisette donnée de son conteneur.
- noizetier_noisette_lister() : array<string|int, mixed>
- Renvoie un champ ou toute la description des noisettes d'un conteneur ou de tous les conteneurs.
- noizetier_noisette_decrire() : array<string|int, mixed>
- Renvoie la description brute d'une noisette sans traitement typo des champs textuels ni désérialisation des champs de type tableau sérialisé.
- noizetier_noisette_initialiser_encapsulation() : string
- Renvoie la configuration par défaut de l'encapsulation d'une noisette.
- noizetier_noisette_verifier_identifiant() : int
- Vérifie l'identifiant d'une noisette : comme le noiZetier gère un entier on le caste en entier pour être sur de son type.
Functions
noizetier_noisette_completer_description()
Complète la description fournie avec les champs propres au noiZetier, à savoir, ceux identifiant la page/composition ou l'objet et le bloc.
noizetier_noisette_completer_description(array<string|int, mixed> $flux) : array<string|int, mixed>
On parse le squelette pour identifier les données manquantes.
Parameters
- $flux : array<string|int, mixed>
-
Description par défaut de la noisette.
Tags
Return values
array<string|int, mixed> —Description de la noisette complétée avec les champs de type de page, composition, bloc et de l'objet concerné si cela est le cas.
noizetier_noisette_stocker()
Stocke la description d'une nouvelle noisette et calcule son identifiant unique, ou met à jour les paramètres d'affichage d'une noisette existante.
noizetier_noisette_stocker(string $plugin, array<string|int, mixed> $description) : int
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noizetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $description : array<string|int, mixed>
-
Description de la noisette. Soit la description ne contient pas l'id de la noisette et c'est un ajout, soit la description contient l'id et c'est une mise à jour.
Return values
int —Id de la noisette de type entier ou 0 en cas d'erreur.
noizetier_noisette_ranger()
Positionne une noisette à un rang différent que celui qu'elle occupe dans le conteneur.
noizetier_noisette_ranger(string $plugin, array<string|int, mixed> $description, int $rang_destination) : bool
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $description : array<string|int, mixed>
-
Description complète de la noisette.
- $rang_destination : int
-
Position à laquelle ranger la noisette au sein du conteneur.
Return values
bool —true si le traitement s'est bien déroulé, false sinon.
noizetier_noisette_destocker()
Retire, de l'espace de stockage, une noisette donnée de son conteneur.
noizetier_noisette_destocker(string $plugin, array<string|int, mixed> $description) : bool
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $description : array<string|int, mixed>
-
Description complète de la noisette.
Return values
bool —true si le traitement s'est bien déroulé, false sinon.
noizetier_noisette_lister()
Renvoie un champ ou toute la description des noisettes d'un conteneur ou de tous les conteneurs.
noizetier_noisette_lister(string $plugin, array<string|int, mixed>|string $conteneur, string $information, string $cle) : array<string|int, mixed>
Le tableau retourné est indexé soit par identifiant de noisette soit par identifiant du conteneur et rang.
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $conteneur : array<string|int, mixed>|string
-
Tableau descriptif du conteneur ou identifiant du conteneur ou vide si on souhaite adresser tous les conteneurs.
- $information : string
-
Identifiant d'un champ de la description d'une type de noisette. Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est un champ invalide la fonction renvoie un tableau vide.
- $cle : string
-
Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit
id_noisettesoitrang.
Return values
array<string|int, mixed> —Tableau de la liste des informations demandées indexé par identifiant de noisette ou par rang.
noizetier_noisette_decrire()
Renvoie la description brute d'une noisette sans traitement typo des champs textuels ni désérialisation des champs de type tableau sérialisé.
noizetier_noisette_decrire(string $plugin, array<string|int, mixed>|int|string $noisette) : array<string|int, mixed>
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $noisette : array<string|int, mixed>|int|string
-
Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (conteneur, rang de noisette).
Return values
array<string|int, mixed> —Tableau de la description du type de noisette. Les champs textuels et les champs de type tableau sérialisé sont retournés en l'état.
noizetier_noisette_initialiser_encapsulation()
Renvoie la configuration par défaut de l'encapsulation d'une noisette.
noizetier_noisette_initialiser_encapsulation(string $plugin) : string
Cette information est utilisée si le champ encapsulation de la noisette vaut defaut.
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
Return values
string —Vaut on pour une encapsulation ou chaine vide sinon.
noizetier_noisette_verifier_identifiant()
Vérifie l'identifiant d'une noisette : comme le noiZetier gère un entier on le caste en entier pour être sur de son type.
noizetier_noisette_verifier_identifiant(string $plugin, int|string $id_noisette) : int
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $id_noisette : int|string
-
Identifiant de la noisette à vérifier.
Return values
int —Identifiant de la noisette vérifié.