SERVICE
Table of Contents
Functions
- noizetier_conteneur_verifier() : array<string|int, mixed>
- Vérifie la conformité des index du tableau représentant le conteneur et supprime les index inutiles, si besoin.
- noizetier_conteneur_identifier() : string
- Construit un identifiant unique pour le conteneur de noisettes hors les noisettes conteneur.
- noizetier_conteneur_construire() : array<string|int, mixed>
- Reconstruit le conteneur sous forme de tableau à partir de son identifiant unique (fonction inverse de `noizetier_conteneur_identifier`).
- noizetier_conteneur_destocker() : bool
- Retire, de l'espace de stockage, toutes les noisettes d'un conteneur.
Functions
noizetier_conteneur_verifier()
Vérifie la conformité des index du tableau représentant le conteneur et supprime les index inutiles, si besoin.
noizetier_conteneur_verifier(string $plugin, array<string|int, mixed> $conteneur) : array<string|int, mixed>
Pour le noiZetier, la vérification concerne uniquement les conteneurs non noisette. Dans ce cas, le conteneur est toujours un squelette, soit générique soit d'un objet donné.
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>
-
Tableau associatif descriptif du conteneur dont les index doivent être vérifiés.
Return values
array<string|int, mixed> —Tableau du conteneur dont tous les index sont conformes (squelette et éventuellement objet, id_objet)
ou tableau vide si non conforme.
noizetier_conteneur_identifier()
Construit un identifiant unique pour le conteneur de noisettes hors les noisettes conteneur.
noizetier_conteneur_identifier(string $plugin, array<string|int, mixed> $conteneur) : string
Pour le noiZetier, un conteneur est toujours un squelette, soit générique soit d'un objet donné.
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>
-
Tableau associatif descriptif du conteneur. Pour le noiZetier, les seuls index autorisés sont
squelette,objetetid_objet.
Return values
string —L'identifiant calculé à partir du tableau.
noizetier_conteneur_construire()
Reconstruit le conteneur sous forme de tableau à partir de son identifiant unique (fonction inverse de `noizetier_conteneur_identifier`).
noizetier_conteneur_construire(string $plugin, string $id_conteneur) : array<string|int, mixed>
N-Core ne fournit le conteneur pour les noisettes conteneur. Pour les autres conteneurs, c'est au noiZetier de calculer le tableau.
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_conteneur : string
-
Identifiant unique du conteneur.
Return values
array<string|int, mixed> —Tableau représentatif du conteneur ou tableau vide en cas d'erreur.
noizetier_conteneur_destocker()
Retire, de l'espace de stockage, toutes les noisettes d'un conteneur.
noizetier_conteneur_destocker(string $plugin, array<string|int, mixed>|string $conteneur) : bool
L'imbrication des conteneurs est gérée dans la fonction de service de N-Core.
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.
Return values
bool —true si le traitement s'est bien déroulé, false sinon.