SPIP Code

Documentation du code de SPIP et de ses plugins

noiZetier

SERVICE

Table of Contents

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.

Functions

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.

Tags
pipeline

type_noisette_completer_description

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.

Tags
pipeline

type_noisette_lister_categories

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.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results