noiZetier

noizetier.php

Functions

noizetier_type_noisette_stocker() : bool: Stocke les descriptions des types de noisette en distinguant les types de noisette obsolètes, les types de noisettes modifiés et les types de noisettes nouveaux.
noizetier_type_noisette_completer_description() : array<string|int, mixed>: Complète la description d'un type de noisette issue de la lecture de son fichier YAML.
noizetier_type_noisette_lister_categories() : array<string|int, mixed>: Complète la liste des catégories et leur description.
noizetier_type_noisette_decrire() : array<string|int, mixed>: Renvoie la description brute d'un type de noisette sans traitement typo ni désérialisation des champs de type tableau sérialisé.
noizetier_type_noisette_lister() : array<string|int, mixed>: Renvoie l'information brute demandée pour l'ensemble des types de noisette utilisés ou toute les descriptions si aucune information n'est explicitement demandée.
noizetier_type_noisette_initialiser_ajax() : string: Renvoie la configuration par défaut de l'ajax à appliquer pour la compilation des noisettes.
noizetier_type_noisette_initialiser_inclusion() : string: Renvoie la configuration par défaut de l'inclusion à appliquer pour la compilation des noisettes.
noizetier_noisette_completer_description() : array<string|int, mixed>: Complète la description fournie avec les champs propres au noiZetier, à savoir, ceux identifiant la page/composition ou l'objet et le bloc.
noizetier_noisette_stocker() : int: Stocke la description d'une nouvelle noisette et calcule son identifiant unique, ou met à jour les paramètres d'affichage d'une noisette existante.
noizetier_noisette_changer_conteneur() : array<string|int, mixed>: Transfère une noisette d'un conteneur vers un autre à un rang donné.
noizetier_noisette_ranger() : bool: Positionne une noisette à un rang différent que celui qu'elle occupe dans le conteneur.
noizetier_noisette_destocker() : bool: Retire, de l'espace de stockage, une noisette donnée de son conteneur.
noizetier_noisette_lister() : array<string|int, mixed>: Renvoie un champ ou toute la description des noisettes d'un conteneur ou de tous les conteneurs.
noizetier_noisette_decrire() : array<string|int, mixed>: Renvoie la description brute d'une noisette sans traitement typo des champs textuels ni désérialisation des champs de type tableau sérialisé.
noizetier_noisette_initialiser_encapsulation() : string: Renvoie la configuration par défaut de l'encapsulation d'une noisette.
noizetier_noisette_verifier_identifiant() : int: Vérifie l'identifiant d'une noisette : comme le noiZetier gère un entier on le caste en entier pour être sur de son type.
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.

noizetier_type_noisette_stocker()

Stocke les descriptions des types de noisette en distinguant les types de noisette obsolètes, les types de noisettes modifiés et les types de noisettes nouveaux.


    
                    noizetier_type_noisette_stocker(string $plugin, array<string|int, mixed> $types_noisettes, bool $recharger) : bool

Chaque description de type de noisette est un tableau associatif dont tous les index possibles - y compris la signature - sont initialisés quelque soit le contenu du fichier YAML.

Les types de noisettes sont stockés dans la table spip_types_noisettes.

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.
$types_noisettes : array<string|int, mixed>: Tableau associatif à 3 entrées fournissant les descriptions des types de noisettes nouveaux, obsolètes et modifiés: a_effacer : liste des identifiants de type de noisette devenus obsolètes. a_changer : liste des descriptions des types de noisette dont le fichier YAML a été modifié. a_ajouter : liste des descriptions des nouveaux types de noisette. Si $recharger est à true, seul l'index a_ajouter est fourni dans le tableau $types_noisette.
$recharger : bool: Indique si le chargement en cours est forcé ou pas. Cela permet à la fonction N-Core ou au service concerné d'optimiser le traitement sachant que seules les types de noisette nouveaux sont fournis.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

noizetier_type_noisette_completer_description()

Complète la description d'un type de noisette issue de la lecture de son fichier YAML.


    
                    noizetier_type_noisette_completer_description(array<string|int, mixed> $flux) : array<string|int, mixed>

Le noiZetier phrase le type de noisette pour détecter son type et sa composition éventuelle. Il ajoute aussi la catégorie liée à la compatibilité aux pages ou composition.

Parameters

$flux : array<string|int, mixed>: Description du type de noisette et arguments du pipeline.

Return values

array<string|int, mixed> —

Description du type de noisette complétée avec le type de page et la composition (éventuellement vides).

noizetier_type_noisette_lister_categories()

Complète la liste des catégories et leur description.


    
                    noizetier_type_noisette_lister_categories(array<string|int, mixed> $flux) : array<string|int, mixed>

Par défaut, le noiZetier ajoute les catégories relatives à la compatibilité des types de noisette avec la page ou la composition en cours de configuration.

Parameters

$flux : array<string|int, mixed>: Liste des descriptions des catégories et arguments du pipeline.

Return values

array<string|int, mixed> —

Flux dont la liste des descriptions a été mise à jour.

noizetier_type_noisette_decrire()

Renvoie la description brute d'un type de noisette sans traitement typo ni désérialisation des champs de type tableau sérialisé.


    
                    noizetier_type_noisette_decrire(string $plugin, string $type_noisette) : array<string|int, mixed>

Le noiZetier lit la description du type de noisette concerné dans la table spip_types_noisettes.

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.
$type_noisette : string: Identifiant du type de noisette.

Return values

array<string|int, mixed> —

Tableau de la description du type de noisette. Les champs textuels et les champs de type tableau sérialisé sont retournés en l'état, le timestamp `maj n'est pas fourni.

noizetier_type_noisette_lister()

Renvoie l'information brute demandée pour l'ensemble des types de noisette utilisés ou toute les descriptions si aucune information n'est explicitement demandée.


    
                    noizetier_type_noisette_lister(string $plugin, string $information) : array<string|int, mixed>

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.
$information : string: Identifiant d'un champ de la description d'un type de noisette. Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est un champ invalide la fonction renvoie un tableau vide.

Return values

array<string|int, mixed> —

Tableau de la forme [type_noisette] = information ou description complète. Les champs textuels et les champs de type tableau sérialisé sont retournés en l'état, le timestamp `maj n'est pas fourni.

noizetier_type_noisette_initialiser_ajax()

Renvoie la configuration par défaut de l'ajax à appliquer pour la compilation des noisettes.


    
                    noizetier_type_noisette_initialiser_ajax(string $plugin) : string

Cette information est utilisée si la description YAML d'un type noisette ne contient pas de tag ajax ou contient un tag ajax à defaut.

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.

Return values

string —

on si par défaut un type de noisette est insérée en ajax, vide sinon.

noizetier_type_noisette_initialiser_inclusion()

Renvoie la configuration par défaut de l'inclusion à appliquer pour la compilation des noisettes.


    
                    noizetier_type_noisette_initialiser_inclusion(string $plugin) : string

Cette information est utilisée si la description YAML d'un type noisette ne contient pas de tag inclusion ou contient un tag inclusion à defaut.

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.

Return values

string —

on si par défaut un type noisette est insérée en dynamique, vide sinon.

noizetier_noisette_completer_description()

Complète la description fournie avec les champs propres au noiZetier, à savoir, ceux identifiant la page/composition ou l'objet et le bloc.


    
                    noizetier_noisette_completer_description(array<string|int, mixed> $flux) : array<string|int, mixed>

On parse le squelette pour identifier les données manquantes.

Parameters

$flux : array<string|int, mixed>: Description par défaut de la noisette.

Return values

array<string|int, mixed> —

Description de la noisette complétée avec les champs de type de page, composition, bloc et de l'objet concerné si cela est le cas.

noizetier_noisette_stocker()

Stocke la description d'une nouvelle noisette et calcule son identifiant unique, ou met à jour les paramètres d'affichage d'une noisette existante.


    
                    noizetier_noisette_stocker(string $plugin, array<string|int, mixed> $description) : int

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.
$description : array<string|int, mixed>: Description de la noisette. Soit la description ne contient pas l'id de la noisette et c'est un ajout, soit la description contient l'id et c'est une mise à jour.

Return values

int —

Id de la noisette de type entier ou 0 en cas d'erreur.

noizetier_noisette_changer_conteneur()

Transfère une noisette d'un conteneur vers un autre à un rang donné.


    
                    noizetier_noisette_changer_conteneur(string $plugin, array<string|int, mixed> $description, string $id_conteneur, int $rang, int $profondeur) : array<string|int, mixed>

Le rang destination n'est pas vérifié lors du rangement dans le conteneur destination. Il convient à l'appelant de vérifier que le rang est libre. La description complète de la noisette est renvoyée avec mise à jour des champs de positionnement (id_conteneur, conteneur, rang_noisette et profondeur).

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.
$description : array<string|int, mixed>: Description de la noisette à changer de conteneur.
$id_conteneur : string: Identifiant unique sous forme de chaine du conteneur destination.
$rang : int: Rang où positionner la noisette dans le conteneur destination. Il faut toujours vérifier au préalable que ce rang est libre.
$profondeur : int: Profondeur de la noisette à sa nouvelle position.

Return values

array<string|int, mixed> —

Description de la noisette mise à jour avec les informations sur le nouvel emplacement

noizetier_noisette_ranger()

Positionne une noisette à un rang différent que celui qu'elle occupe dans le conteneur.


    
                    noizetier_noisette_ranger(string $plugin, array<string|int, mixed> $description, int $rang_destination) : 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.
$description : array<string|int, mixed>: Description complète de la noisette.
$rang_destination : int: Position à laquelle ranger la noisette au sein du conteneur.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

noizetier_noisette_destocker()

Retire, de l'espace de stockage, une noisette donnée de son conteneur.


    
                    noizetier_noisette_destocker(string $plugin, array<string|int, mixed> $description) : 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.
$description : array<string|int, mixed>: Description complète de la noisette.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

noizetier_noisette_lister()

Renvoie un champ ou toute la description des noisettes d'un conteneur ou de tous les conteneurs.


    
                    noizetier_noisette_lister(string $plugin, array<string|int, mixed>|string $conteneur, string $information, string $cle) : array<string|int, mixed>

Le tableau retourné est indexé soit par identifiant de noisette soit par identifiant du conteneur et rang.

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 ou vide si on souhaite adresser tous les conteneurs.
$information : string: Identifiant d'un champ de la description d'une type de noisette. Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est un champ invalide la fonction renvoie un tableau vide.
$cle : string: Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit id_noisette soit rang.

Return values

array<string|int, mixed> —

Tableau de la liste des informations demandées indexé par identifiant de noisette ou par rang.

noizetier_noisette_decrire()

Renvoie la description brute d'une noisette sans traitement typo des champs textuels ni désérialisation des champs de type tableau sérialisé.


    
                    noizetier_noisette_decrire(string $plugin, array<string|int, mixed>|int|string $noisette) : array<string|int, mixed>

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.
$noisette : array<string|int, mixed>|int|string: Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (conteneur, rang de noisette).

Return values

array<string|int, mixed> —

Tableau de la description du type de noisette. Les champs textuels et les champs de type tableau sérialisé sont retournés en l'état.

noizetier_noisette_initialiser_encapsulation()

Renvoie la configuration par défaut de l'encapsulation d'une noisette.


    
                    noizetier_noisette_initialiser_encapsulation(string $plugin) : string

Cette information est utilisée si le champ encapsulation de la noisette vaut defaut.

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.

Return values

string —

Vaut on pour une encapsulation ou chaine vide sinon.

noizetier_noisette_verifier_identifiant()

Vérifie l'identifiant d'une noisette : comme le noiZetier gère un entier on le caste en entier pour être sur de son type.


    
                    noizetier_noisette_verifier_identifiant(string $plugin, int|string $id_noisette) : int

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_noisette : int|string: Identifiant de la noisette à vérifier.

Return values

int —

Identifiant de la noisette vérifié.

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, objet et id_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.

noizetier.php

Table of Contents

Functions

Functions

noizetier_type_noisette_stocker()

Parameters

Return values

noizetier_type_noisette_completer_description()

Parameters

Tags

Return values

noizetier_type_noisette_lister_categories()

Parameters

Tags

Return values

noizetier_type_noisette_decrire()

Parameters

Return values

noizetier_type_noisette_lister()

Parameters

Return values

noizetier_type_noisette_initialiser_ajax()

Parameters

Return values

noizetier_type_noisette_initialiser_inclusion()

Parameters

Return values

noizetier_noisette_completer_description()

Parameters

Tags

Return values

noizetier_noisette_stocker()

Parameters

Return values

noizetier_noisette_changer_conteneur()

Parameters

Return values

noizetier_noisette_ranger()

Parameters

Return values

noizetier_noisette_destocker()

Parameters

Return values

noizetier_noisette_lister()

Parameters

Return values

noizetier_noisette_decrire()

Parameters

Return values

noizetier_noisette_initialiser_encapsulation()

Parameters

Return values

noizetier_noisette_verifier_identifiant()

Parameters

Return values

noizetier_conteneur_verifier()

Parameters

Return values

noizetier_conteneur_identifier()

Parameters

Return values

noizetier_conteneur_construire()

Parameters

Return values

noizetier_conteneur_destocker()

Parameters

Return values