SPIP Code

Documentation du code de SPIP et de ses plugins

noiZetier

noizetier_fonctions.php

Ce fichier contient les filtres et balises du noiZetier.

Table of Contents

Functions

critere_TYPES_NOISETTES_categories_dist()  : void
Surcharge du critère natif categories correspondant au champ homonyme de la table spip_types_noisettes.
calculer_critere_categories()  : string
Renvoie la condition SQL correspondant à l'utilisation du critère `categories`.
balise_CONTENEUR_NOIZETIER_IDENTIFIER_dist()  : Champ
Compile la balise `#CONTENEUR_NOIZETIER_IDENTIFIER` qui fournit l'id du conteneur désigné par ses éléments canoniques propres au noiZetier. La balise est une encapsulation de la fonction `conteneur_noizetier_composer` mais ne permet de calculer l'id d'un conteneur noisette car ce cas n'est pas utilisable dans un HTML. Elle est à utiliser de préférence à celle fournie par N-Core (`#CONTENEUR_IDENTIFIER`).
balise_ICONE_NOIZETIER_LISTE_dist()  : Champ
Compile la balise `#ICONE_NOIZETIER_LISTE` qui fournit la liste des icones d'une taille donnée en pixels disponibles dans les thèmes SPIP de l'espace privé.
balise_BLOC_NOIZETIER_INFOS_dist()  : Champ
Compile la balise `#BLOC_NOIZETIER_INFOS` qui fournit un champ ou tous les champs descriptifs d'un bloc Z donné. Ces champs sont lus dans le fichier YAML du bloc si il existe.
balise_PAGE_NOIZETIER_INFOS_dist()  : Champ
Compile la balise `#PAGE_NOIZETIER_INFOS` qui fournit un champ ou tous les champs descriptifs d'une page ou d'une composition donnée. Ces champs sont lus dans la table `spip_noizetier_pages`.
balise_OBJET_NOIZETIER_INFOS_dist()  : Champ
Compile la balise `#OBJET_NOIZETIER_INFOS` qui fournit un champ ou tous les champs descriptifs d'un objet donné. Ces champs sont lus dans la table de l'objet.
balise_OBJET_NOIZETIER_LISTE_dist()  : Champ
Compile la balise `#OBJET_NOIZETIER_LISTE` qui renvoie la liste des objets possédant des noisettes configurées. Chaque objet est fourni avec sa description complète.

Functions

critere_TYPES_NOISETTES_categories_dist()

Surcharge du critère natif categories correspondant au champ homonyme de la table spip_types_noisettes.

critere_TYPES_NOISETTES_categories_dist(string $idb, array<string|int, mixed> &$boucles, Critere $critere) : void

Si le paramètre du critère est une liste de catégories, le critère applique un OU sur chaque catégorie ou un ET si l'opérateur de négation est utilisé sur le critère. Par contre; il est possible de combiner plusieurs critères categories dans une même boucle dont les conditions sont combinées en ET.

Parameters
$idb : string

Identifiant de la boucle.

$boucles : array<string|int, mixed>

AST du squelette.

$critere : Critere

Paramètres du critère dans la boucle.

Tags
uses
calculer_critere_categories()
critere
example

Utilisation standard avec un paramètre non vide: {type_noisette_categorie param} où param peut prendre les valeurs suivantes:

  • une valeur immédiate ou une liste de valeurs immédiates comme "c1,c2"
  • une variable d'un ENV ou GET qui elle-même peut être une chaine unique, une chaine de type liste séparée par des virgules ou un tableau
  • une combinaison comme c1,#GET{variable} {!type_noisette_categorie param} la négation de tous les cas précédents Cas d'un paramètre vide: {type_noisette_categorie} n'applique aucun critère {!type_noisette_categorie} renvoie les types de noisette sans catégorie (à priori n'existe pas)

calculer_critere_categories()

Renvoie la condition SQL correspondant à l'utilisation du critère `categories`.

calculer_critere_categories(array<string|int, mixed> $parametres, string $operateur) : string
Parameters
$parametres : array<string|int, mixed>

Liste des identifiants de catégories. Si plusieurs catégories sont fournies la fonction fait un OR sur les conditions unitaires.

$operateur : string

Opérateur de comparaison, tel que '>' ou '='.

Tags
used-by
critere_TYPES_NOISETTES_categories_dist()
Return values
string

balise_CONTENEUR_NOIZETIER_IDENTIFIER_dist()

Compile la balise `#CONTENEUR_NOIZETIER_IDENTIFIER` qui fournit l'id du conteneur désigné par ses éléments canoniques propres au noiZetier. La balise est une encapsulation de la fonction `conteneur_noizetier_composer` mais ne permet de calculer l'id d'un conteneur noisette car ce cas n'est pas utilisable dans un HTML. Elle est à utiliser de préférence à celle fournie par N-Core (`#CONTENEUR_IDENTIFIER`).

balise_CONTENEUR_NOIZETIER_IDENTIFIER_dist(Champ $p) : Champ

La signature de la balise est : #CONTENEUR_NOIZETIER_IDENTIFIER{page_ou_objet, bloc}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#CONTENEUR_NOIZETIER_IDENTIFIER{article, content}, renvoie l'id du conteneur représentant le bloc content/article
#CONTENEUR_NOIZETIER_IDENTIFIER{array(objet => article, id_article => 12), content}, renvoie l'id du conteneur
représentant le bloc content de l'objet article12
Return values
Champ —

Pile complétée par le code à générer.

balise_ICONE_NOIZETIER_LISTE_dist()

Compile la balise `#ICONE_NOIZETIER_LISTE` qui fournit la liste des icones d'une taille donnée en pixels disponibles dans les thèmes SPIP de l'espace privé.

balise_ICONE_NOIZETIER_LISTE_dist(Champ $p) : Champ

La signature de la balise est : #ICONE_NOIZETIER_LISTE{taille}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#ICONE_NOIZETIER_LISTE{24}, renvoie les icones de taille 24px présents dans les thèmes du privé
Return values
Champ —

Pile complétée par le code à générer.

balise_BLOC_NOIZETIER_INFOS_dist()

Compile la balise `#BLOC_NOIZETIER_INFOS` qui fournit un champ ou tous les champs descriptifs d'un bloc Z donné. Ces champs sont lus dans le fichier YAML du bloc si il existe.

balise_BLOC_NOIZETIER_INFOS_dist(Champ $p) : Champ

La signature de la balise est : #BLOC_NOIZETIER_INFOS{bloc, information}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#BLOC_NOIZETIER_INFOS{content}, renvoie tous les champs descriptifs du bloc content
#BLOC_NOIZETIER_INFOS{content, nom}, renvoie le titre du bloc content
Return values
Champ —

Pile complétée par le code à générer.

balise_PAGE_NOIZETIER_INFOS_dist()

Compile la balise `#PAGE_NOIZETIER_INFOS` qui fournit un champ ou tous les champs descriptifs d'une page ou d'une composition donnée. Ces champs sont lus dans la table `spip_noizetier_pages`.

balise_PAGE_NOIZETIER_INFOS_dist(Champ $p) : Champ

La signature de la balise est : #PAGE_NOIZETIER_INFOS{page, information}.

La fonction peut aussi renvoyer d'autres informations calculées, à savoir :

  • est_disponible qui indique si le fichier est dans le PATH (plugin fournisseur désactivé mais base toujours remplie).
  • est_modifiee qui indique si la configuration du fichier YAML ou XML de la page a été modifiée ou pas.
  • compteurs_type_noisette qui donne le nombre de types de noisettes disponibles pour la page ou la composition donnée en distinguant les types de noisettes communs à toutes les pages, les types de noisettes spécifiques à un type de page et les types de noisettes spécifiques à une composition.
  • compteurs_noisette qui donne le nombre de noisettes incluses dans chaque bloc de la page.
Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#PAGE_NOIZETIER_INFOS{article}, renvoie tous les champs descriptifs de la page article
#PAGE_NOIZETIER_INFOS{article, nom}, renvoie le titre de la page article
#PAGE_NOIZETIER_INFOS{article-forum, nom}, renvoie le titre de la composition forum de la page article
#PAGE_NOIZETIER_INFOS{article, est_disponible}, indique si le fichier HTML de la page est accessible via le PATH
#PAGE_NOIZETIER_INFOS{article, est_modifiee}, indique si la configuration de la page article a été modifiée
#PAGE_NOIZETIER_INFOS{article, compteurs_type_noisette}, fournit les compteurs de types de noisette compatibles
#PAGE_NOIZETIER_INFOS{article, compteurs_noisette}, fournit les compteurs de noisettes incluses par bloc
Return values
Champ —

Pile complétée par le code à générer.

balise_OBJET_NOIZETIER_INFOS_dist()

Compile la balise `#OBJET_NOIZETIER_INFOS` qui fournit un champ ou tous les champs descriptifs d'un objet donné. Ces champs sont lus dans la table de l'objet.

balise_OBJET_NOIZETIER_INFOS_dist(Champ $p) : Champ

La signature de la balise est : #OBJET_NOIZETIER_INFOS{type_objet, id_objet, information}.

La fonction peut aussi renvoyer d'autres informations calculées, à savoir :

  • compteurs_noisette qui donne le nombre de noisettes incluses dans chaque bloc de l'objet.
Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#OBJET_NOIZETIER_INFOS{article, 12}, renvoie tous les champs descriptifs de l'article 12
#OBJET_NOIZETIER_INFOS{article, 12, nom}, renvoie le titre de l'article 12
#OBJET_NOIZETIER_INFOS{article, 12, compteurs_noisette}, fournit les compteurs de noisettes incluses par bloc pour l'article 12
#OBJET_NOIZETIER_INFOS{article, 12, type_est_active}, renvoie si les noisettes sont autorisées sur l'article (tous les articles)
#OBJET_NOIZETIER_INFOS{article, 12, composition_est_activee}, renvoie si les compositions sont activées sur l'article (tous les articles)
#OBJET_NOIZETIER_INFOS{article, 12, composition_active}, reboie la composition active sur l'article 12
Return values
Champ —

Pile complétée par le code à générer.

balise_OBJET_NOIZETIER_LISTE_dist()

Compile la balise `#OBJET_NOIZETIER_LISTE` qui renvoie la liste des objets possédant des noisettes configurées. Chaque objet est fourni avec sa description complète.

balise_OBJET_NOIZETIER_LISTE_dist(Champ $p) : Champ

La signature de la balise est : #OBJET_NOIZETIER_LISTE.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
Return values
Champ —

Pile complétée par le code à générer.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results