noizetier_conteneur.php
Ce fichier contient l'API complémentaire spécifique au noiZetier de gestion des conteneurs.
Table of Contents
Functions
- conteneur_noizetier_composer() : string
- Détermine l'id du conteneur à partir des données d'une page, d'un objet ou d'une noisette conteneur.
- conteneur_noizetier_decomposer() : array<string|int, mixed>
- Détermine à partir de l'id du conteneur les données propres au noiZetier, à savoir, la page, l'objet ou la noisette conteneur concernée.
Functions
conteneur_noizetier_composer()
Détermine l'id du conteneur à partir des données d'une page, d'un objet ou d'une noisette conteneur.
conteneur_noizetier_composer(array<string|int, mixed>|string $page_ou_objet, string $bloc[, null|array<string|int, mixed> $noisette = [] ]) : string
Cette fonction est en fait une encapsalution de la fonction conteneur_identifier() qui permet de reconstituer le conteneur à partir des données du noizetier page, composition, objet et noisette.
Parameters
- $page_ou_objet : array<string|int, mixed>|string
-
Page au sens SPIP ou objet spécifiquement identifié.
- dans le cas d'une page SPIP comme sommaire, l'argument est une chaîne.
- dans le cas d'un objet SPIP comme un article d'id x, l'argument est un tableau associatif à deux index,
objetetid_objet.
- $bloc : string
-
Bloc de page au sens Z.
- $noisette : null|array<string|int, mixed> = []
-
Tableau descriptif d'une noisette contenant à minima son type et son id.
Tags
Return values
string —Identifiant unique du conteneur au format chaine.
conteneur_noizetier_decomposer()
Détermine à partir de l'id du conteneur les données propres au noiZetier, à savoir, la page, l'objet ou la noisette conteneur concernée.
conteneur_noizetier_decomposer(string $id_conteneur) : array<string|int, mixed>
Le tableau ainsi produit peut-être fourni aux autorisations concernant la manipulation des pages du noiZetier.
Parameters
- $id_conteneur : string
-
Identifiant du conteneur sous forme de chaine unique.
Tags
Return values
array<string|int, mixed> —Tableau des données du conteneur (permet aussi son identification).