Fichier noizetier_fonctions.php

Ce fichier contient les filtres et balises du noiZetier.

Source

Liste des fonctions

APIs

string calculer_critere_categories( array $parametres , string $operateur )

Paramètres

  1. array $parametres

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

  2. string $operateur

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

Retour

  • string

API

Package

Internes

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

\Champ balise_BLOC_NOIZETIER_INFOS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

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

Exemples

  • #BLOC_NOIZETIER_INFOS{content}, renvoie tous les champs descriptifs du bloc content
    #BLOC_NOIZETIER_INFOS{content, nom}, renvoie le titre du bloc content

Package

Balise

  • BLOC_NOIZETIER_INFOS

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

\Champ balise_CONTENEUR_NOIZETIER_IDENTIFIER_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

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

Exemples

  • #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

Balise

  • CONTENEUR_NOIZETIER_IDENTIFIER

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

\Champ balise_ICONE_NOIZETIER_LISTE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

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

Exemples

  • #ICONE_NOIZETIER_LISTE{24}, renvoie les icones de taille 24px présents dans les thèmes du privé

Package

Balise

  • ICONE_NOIZETIER_LISTE

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.
\Champ balise_OBJET_NOIZETIER_INFOS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

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

Exemples

  • #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

Package

Balise

  • OBJET_NOIZETIER_INFOS

La signature de la balise est : #OBJET_NOIZETIER_LISTE.

\Champ balise_OBJET_NOIZETIER_LISTE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

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

Package

Balise

  • OBJET_NOIZETIER_LISTE

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.

\Champ balise_PAGE_NOIZETIER_INFOS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

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

Exemples

  • #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

Package

Balise

  • PAGE_NOIZETIER_INFOS
array | string calculer_id_conteneur( $page_ou_objet , string $bloc )

Paramètres

  1. $page_ou_objet
  2. string $bloc

Retour

  • array | string

Package

Internal

array | string calculer_infos_bloc( string $bloc = '' , string $information = '' )

Paramètres

  1. string $bloc = ''
  2. string $information = ''

Retour

  • array | string

Package

Internal

mixed calculer_infos_objet( $objet , $id_objet , string $information = '' )

Paramètres

  1. $objet
  2. $id_objet
  3. string $information = ''

Retour

  • mixed

Package

Internal

mixed calculer_infos_page( $page , string $information = '' )

Paramètres

  1. $page
  2. string $information = ''

Retour

  • mixed

Package

Internal

array | string calculer_liste_icones( integer $taille = 24 )

Paramètres

  1. integer $taille = 24

Retour

  • array | string

Package

Internal

array | string calculer_liste_objets( )

Retour

  • array | string

Package

Internal

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.

void critere_TYPES_NOISETTES_categories_dist( string $idb , array & $boucles , \Critere $critere )

Paramètres

  1. string $idb

    Identifiant de la boucle.

  2. array & $boucles

    AST du squelette.

  3. \Critere $critere

    Paramètres du critère dans la boucle.

Retour

  • void

Exemples

  • 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)

Critere

  • TYPES_NOISETTES_categories

Liste des erreurs

GravitéLigneDescription
Erreur 193
  • No summary for function \calculer_id_conteneur()
  • Name of argument $bloc does not match with the DocBlock's name $information in \calculer_id_conteneur()
  • Name of argument $page_ou_objet does not match with the DocBlock's name $bloc in \calculer_id_conteneur()
Notice 193
  • Parameter $information could not be found in \calculer_id_conteneur()
Erreur 237
  • No summary for function \calculer_liste_icones()
Erreur 292
  • No summary for function \calculer_infos_bloc()
Erreur 359
  • No summary for function \calculer_infos_page()
Erreur 501
  • No summary for function \calculer_infos_objet()
Erreur 547
  • No summary for function \calculer_liste_objets()