API
Table of Contents
Functions
- conteneur_identifier() : string
- Calcule l'identifiant unique pour le conteneur sous forme de chaine.
- conteneur_construire() : array<string|int, mixed>
- Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `conteneur_identifier`).
- conteneur_est_noisette() : bool
- Détermine si un conteneur est une noisette ou pas.
- conteneur_vider() : bool
- Supprime toutes les noisettes d’un conteneur.
Functions
conteneur_identifier()
Calcule l'identifiant unique pour le conteneur sous forme de chaine.
conteneur_identifier(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : string
Cette fonction est juste un wrapper pour le service ncore_conteneur_identifier().
Elle est utilisée par les balises #NOISETTE_COMPILER et #CONTENEUR_IDENTIFIER.
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.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
string —Identifiant du conteneur ou chaine vide en cas d'erreur.
conteneur_construire()
Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `conteneur_identifier`).
conteneur_construire(string $plugin, string $id_conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>
Cette fonction est juste un wrapper pour le service ncore_conteneur_construire() mais est très utilisée
par les plugins utilisateur.
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 au format chaine.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
array<string|int, mixed> —Tableau représentatif du conteneur ou tableau vide en cas d'erreur.
conteneur_est_noisette()
Détermine si un conteneur est une noisette ou pas.
conteneur_est_noisette(string $plugin, array<string|int, mixed>|string $conteneur[, null|string $stockage = '' ]) : 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.
- $conteneur : array<string|int, mixed>|string
-
Identifiant unique du conteneur ou tableau du conteneur.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
bool —true si le conteneur est une noisette false sinon.
conteneur_vider()
Supprime toutes les noisettes d’un conteneur.
conteneur_vider(string $plugin, array<string|int, mixed>|string $conteneur[, null|string $stockage = '' ]) : bool
L'éventuelle imbrication de conteneurs est gérée dans la fonction de service ncore_conteneur_destocker().
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.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
bool —true si le vidage s'est bien passé, false sinon.