SERVICE
Table of Contents
Functions
- ncore_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.
- ncore_conteneur_identifier() : string
- Construit un identifiant unique pour le conteneur sous forme de chaine.
- ncore_conteneur_construire() : array<string|int, mixed>
- Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `ncore_conteneur_identifier`).
- ncore_conteneur_est_noisette() : bool
- Détermine si un conteneur est une noisette ou pas. Le conteneur a été vérifié au préalable.
- ncore_conteneur_destocker() : bool
- Retire, de l'espace de stockage, toutes les noisettes d'un conteneur et ce de façon récursive si il existe une imbrication de conteneurs.
Functions
ncore_conteneur_verifier()
Vérifie la conformité des index du tableau représentant le conteneur et supprime les index inutiles, si besoin.
ncore_conteneur_verifier(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>
N-Core vérifie que pour les noisettes conteneur les seuls index sont le type et l'id de la noisette. Pour les autres conteneurs, c'est au plugin utilisateur de vérifier le conteneur.
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 vont être vérifiés.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
array<string|int, mixed> —Tableau du conteneur dont tous les index sont conformes ou tableau vide si non conforme.
ncore_conteneur_identifier()
Construit un identifiant unique pour le conteneur sous forme de chaine.
ncore_conteneur_identifier(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : string
N-Core ne fournit d'identifiant que pour les noisettes conteneur. Pour les autres conteneurs, c'est au plugin utilisateur de calculer l'identifiant.
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. Les index sont spécifiques à l'utilisation qui en est faite par le plugin utilisateur. Néanmoins, pour une noisette conteneur, le tableau est limité aux index type de noisette et id de noisette.
- $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.
ncore_conteneur_construire()
Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `ncore_conteneur_identifier`).
ncore_conteneur_construire(string $plugin, string $id_conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>
N-Core ne fournit le tableau que pour les noisettes conteneur. Pour les autres conteneurs, c'est au plugin utilisateur 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. Si l'id correspond à une noisette conteneur le traitement sera fait par N-Core, sinon par le plugin utilisateur
- $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.
ncore_conteneur_est_noisette()
Détermine si un conteneur est une noisette ou pas. Le conteneur a été vérifié au préalable.
ncore_conteneur_est_noisette(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : bool
Ce service n'est pas surchargeable par un plugin utilisateur car les noisettes conteneur sont gérées entièrement par N-Core. Son prototype ne nécessite pas les arguments plugin et stockage.
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>
-
Identifiant du conteneur sous forme de tableau canonique.
- $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.
ncore_conteneur_destocker()
Retire, de l'espace de stockage, toutes les noisettes d'un conteneur et ce de façon récursive si il existe une imbrication de conteneurs.
ncore_conteneur_destocker(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
-
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 traitement s'est bien déroulé, false sinon.