API
Table of Contents
Functions
- objet_noizetier_lire() : array<string|int, mixed>|int|string
- Renvoie la description complète ou uniquement une information précise pour un objet donné.
- objet_noizetier_lire_composition() : string
- Renvoie la composition associée à un objet.
- objet_noizetier_repertorier() : array<string|int, mixed>
- Lister les contenus ayant des noisettes spécifiquement configurées pour leur page.
- objet_noizetier_type_active() : bool
- Détermine si un type d'objet est activé dans la configuration du noiZetier.
- objet_noizetier_compter_noisettes() : array<string|int, mixed>
- Détermine, pour un objet donné, la liste des blocs ayant des noisettes incluses et renvoie leur nombre.
- objet_noizetier_afficher_configuration() : string
- Affiche, pour un objet donné, des liens pour configurer les noisettes.
Functions
objet_noizetier_lire()
Renvoie la description complète ou uniquement une information précise pour un objet donné.
objet_noizetier_lire(string $type_objet, int $id_objet[, null|string $information = '' ]) : array<string|int, mixed>|int|string
Cette fonction est utilisable dans le public via la balise #OBJET_NOIZETIER_INFOS.
Parameters
- $type_objet : string
-
Type de l'objet comme
article. - $id_objet : int
-
Id de l'objet.
- $information : null|string = ''
-
Champ précis à renvoyer ou chaîne vide pour renvoyer toutes les champs de l'objet.
Return values
array<string|int, mixed>|int|string —La description complète sous forme de tableau ou l'information précise demandée.
objet_noizetier_lire_composition()
Renvoie la composition associée à un objet.
objet_noizetier_lire_composition(string $type_objet, int $id_objet) : string
Parameters
- $type_objet : string
-
Le type d'objet comme
article. - $id_objet : int
-
L'id de l'objet.
Return values
string —Le nom de la composition seule ou vide sinon.
objet_noizetier_repertorier()
Lister les contenus ayant des noisettes spécifiquement configurées pour leur page.
objet_noizetier_repertorier([null|array<string|int, mixed> $filtres = [] ]) : array<string|int, mixed>
Cette fonction est utilisable dans le public via la balise #OBJET_NOIZETIER_LISTE.
Parameters
- $filtres : null|array<string|int, mixed> = []
-
Liste des champs sur lesquels appliquer les filtres des objets.
Return values
array<string|int, mixed> —Tableau des descriptions de chaque objet trouvés. Ce tableau est éventuellement filtré sur un ou plusieurs champs de la description.
objet_noizetier_type_active()
Détermine si un type d'objet est activé dans la configuration du noiZetier.
objet_noizetier_type_active(string $type_objet) : bool
Si oui, ses objets peuvent recevoir une configuration de noisettes.
Parameters
- $type_objet : string
-
Type d'objet SPIP comme article, rubrique...
Return values
bool —truet si le type d'objet est activé, false` sinon.
objet_noizetier_compter_noisettes()
Détermine, pour un objet donné, la liste des blocs ayant des noisettes incluses et renvoie leur nombre.
objet_noizetier_compter_noisettes(string $type_objet, int $id_objet) : array<string|int, mixed>
Parameters
- $type_objet : string
-
Le type d'objet comme
article. - $id_objet : int
-
L'id de l'objet.
Return values
array<string|int, mixed> —Tableau des nombre de noisettes incluses par bloc de la forme [bloc] = nombre de noisettes.
objet_noizetier_afficher_configuration()
Affiche, pour un objet donné, des liens pour configurer les noisettes.
objet_noizetier_afficher_configuration(string $type_objet, int $id_objet) : string
Parameters
- $type_objet : string
-
Le type d'objet comme
article. - $id_objet : int
-
L'id de l'objet.
Return values
string —Texte HTML des liens.