Documentation du code de SPIP et de ses plugins

noiZetier

Documentation

Packages

SPIP
Application

Table of Contents

_DIR_CODE  = \_DIR_CACHE . 'recuperer_code/'
action_activer_composition_dist()  : void
Cette action permet d'activer de façon sécurisée l'utilisation de composition sur un type d'objet.
action_ajouter_noisette_dist()  : void
action_decaler_noisette_dist()  : void
Cette action permet à l'utilisateur de déplacer une noisette d'un rang vers le haut ou vers le bas, de façon sécurisée.
action_deplacer_noisette_dist()  : void
Action déplacer une noisette en ajax
action_dupliquer_noisette_dist()  : void
Cette action permet à l'utilisateur de copier, de façon sécurisée, une noisette donnée et sa descendance si celle-ci est un conteneur au rang suivant dans le même conteneur.
action_migrer_schema_070_dist()  : void
Cette action permet à l'utilisateur de migrer le contenu de la base du schéma 0.6.0 au schéma 0.7.0, de façon sécurisée, Les types de noisette sont rechargés pour peupler le champ css_saisies et les noisettes sont mises à jour pour peupler le champ css_saisies et mettre à jour les champs paramètres et css des noisettes conteneur.
action_recharger_pages_dist()  : void
Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, une page ou l'ensemble des pages à partir de leur fichier XML ou YAML.
action_recharger_types_noisette_dist()  : void
Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les types de noisette à partir de leur fichier YAML.
action_supprimer_composition_dist()  : void
Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, une composition virtuelle donnée.
action_supprimer_noisette_dist()  : void
Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, une noisette donnée et sa descendance si celle-ci est un conteneur.
action_vider_conteneur_dist()  : void
Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, toutes les noisettes d'un conteneur qu'il soit un bloc ou une noisette.
action_vider_page_dist()  : void
Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, toutes les noisettes d'une page ou d'un objet.
noizetier_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
noizetier_declarer_tables_principales()  : array<string|int, mixed>
Déclaration des nouvelles tables de la base de données propres au plugin.
formulaires_ajouter_noisette_charger_dist()  : array<string|int, mixed>
Formulaire listant les noisettes incluses dans un conteneur de type (page, bloc), (objet, bloc) ou noisette conteneur.
formulaires_ajouter_noisette_verifier_dist()  : mixed
formulaires_ajouter_noisette_traiter_dist()  : mixed
formulaires_configurer_noizetier_charger_dist()  : mixed
formulaires_configurer_noizetier_traiter_dist()  : mixed
lister_objets_exclus()  : array<string|int, mixed>|null
Renvoie la liste des types d'objet ne pouvant pas être personnalisés car ne possédant pas de page détectable par le noiZetier.
formulaires_editer_page_charger_dist()  : array<string|int, mixed>
Formulaire d'édition d'une page de composition de noisettes.
formulaires_editer_page_verifier_dist()  : array<string|int, mixed>
formulaires_editer_page_traiter_dist()  : array<string|int, mixed>
construire_heritages()  : array<string|int, mixed>
Détermine les compositions héritables par le type de page et les héritages définis pour chaque type d'objet concerné par la composition désignée par $page.
formulaires_etendre_noisette_charger_dist()  : array<string|int, mixed>
Formulaire listant les pages compatibles avec la noisette passée en argument et pouvant donc recevoir cette même noisette dans le bloc fourni en argument.
formulaires_etendre_noisette_verifier_dist()  : mixed
formulaires_etendre_noisette_traiter_dist()  : mixed
formulaires_lister_noisettes_bloc_charger_dist()  : array<string|int, mixed>
La fonction charger déclare les champs postés et y intègre les valeurs par défaut.
formulaires_lister_noisettes_bloc_traiter_dist()  : array<string|int, mixed>
formulaires_preremplir_page_charger_dist()  : array<string|int, mixed>
Formulaire listant les pages compatibles permettant de pré-remplir la page ou le contenu vide en cours de configuration.
formulaires_preremplir_page_verifier_dist()  : mixed
formulaires_preremplir_page_traiter_dist()  : mixed
bloc_noizetier_lister_defaut()  : array<string|int, mixed>
Renvoie la liste par défaut des identifiants des blocs d'une page.
bloc_noizetier_lire()  : array<string|int, mixed>|string
Retourne la description complète ou une information particulière d'un bloc donné.
conteneur_noizetier_composer()  : string
Détermine l'id du conteneur à partir des données d'une page, d'un objet ou d'une noisette conteneur.
conteneur_noizetier_decomposer()  : array<string|int, mixed>
Détermine à partir de l'id du conteneur les données propres au noiZetier, à savoir, la page, l'objet ou la noisette conteneur concernée.
objet_noizetier_lire()  : mixed
Renvoie la description complète ou uniquement une information précise pour un objet donné.
objet_noizetier_lire_composition()  : bool
Renvoie la composition associée à un objet.
objet_noizetier_repertorier()  : array<string|int, mixed>|string
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()  : mixed
page_noizetier_charger()  : bool
page_noizetier_initialiser()  : array<string|int, mixed>
Initialise avec des valeurs par défaut la description d'une page connue par son identifiant.
page_noizetier_virtuelle_propager()  : void
Propage éventuellement les modifications des pages non virtuelles vers les compositions virtuelles associées.
page_noizetier_lire()  : array<string|int, mixed>|string
Retourne la description complète de la page, de la composition explicite ou de la composition virtuelle demandée ou une information donnée uniquement.
page_noizetier_repertorier()  : array<string|int, mixed>
Retourne la description complète ou partielle d'une liste de pages explicites, compositions explicite et compositions virtuelles filtrées sur une liste de critères.
page_noizetier_lister_blocs()  : array<string|int, mixed>
page_noizetier_extraire_type()  : string
Renvoie le type d'une page à partir de son identifiant.
page_noizetier_extraire_composition()  : string
Détermine, à partir de son identifiant, la composition d'une page si elle existe.
page_noizetier_composition_activee()  : bool
Détermine si les compositions sont possibles sur un type de page.
page_noizetier_initialiser_dossier()  : string
Déterminer le répertoire dans lequel le NoiZetier peut lister les pages pouvant supporter l'insertion de noisettes.
page_noizetier_compter_noisettes()  : array<string|int, mixed>
Détermine, pour une page donnée, la liste des blocs ayant des noisettes incluses et renvoie leur nombre.
compiler_traductions_idiome()  : string
Compiler les traductions d'un idiome représentant le nom d'une page en une chaine multi.
calculer_condition_par_filtre()  : array<string|int, mixed>
Construit le tableau des conditions au format compatible avec l'API SQL à partir du tableau des filtres au format [champ] = valeur.
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()  : bool
Renvoie la configuration par défaut de l'ajax à appliquer pour la compilation des noisettes.
noizetier_type_noisette_initialiser_inclusion()  : bool
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_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_recuperer_code()  : mixed
recupere le resultat du calcul d'une compilation de code de squelette $coucou = $this->recuperer_code('[(#AUTORISER{ok}|oui)coucou]');
noizetier_upgrade()  : void
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
noizetier_vider_tables()  : void
Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.
maj_060()  : void
Migration du schéma 0.5 au 0.6.
maj_070()  : void
Migration du schéma 0.6 au 0.7.
maj_080()  : void
Migration du schéma 0.7 au 0.8.
maj_090()  : void
Migration du schéma 0.8 au 0.9.
noizetier_autoriser()  : mixed
Fonction appelée par le pipeline
autoriser_noizetier_dist()  : bool
Autorisation minimale d'accès à toutes les pages du noiZetier sauf celle de configuration du plugin lui-même.
autoriser_noizetier_menu_dist()  : bool
Autorisation d'affichage du menu d'accès à la configuration du noiZetier (page=noizetier_pages).
autoriser_noizetier_configurer_dist()  : bool
Autorisation d'accès à la page de configuration du plugin noiZetier (page=configurer_noizetier).
autoriser_noizetier_configurerpage_dist()  : bool
Autorisation de configuration d'une page ou d'un objet du noiZetier (page=noizetier_page).
autoriser_noizetier_activercomposition_dist()  : bool
Autorisation d'activation des compositions sur un type d'objet. Permet de lancer l'action depuis le noiZetier sans passer par la configuration du plugin Compositions.
autoriser_noizetier_creercomposition_dist()  : bool
Autorisation de création d'une composition virtuelle du noiZetier à partir d'une page source (page=noizetier_page_edit).
autoriser_noizetier_supprimercomposition_dist()  : bool
Autorisation de suppression d'une composition virtuelle du noiZetier.
autoriser_noizetier_modifierpage_dist()  : bool
Autorisation de modification certains paramètres d'une page (page=noizetier_page_edit). Suivant que la page est une page explicite ou une composition virtuelle la liste des paramètres éditables varie.
autoriser_noizetier_dupliquercomposition_dist()  : bool
Autorisation de copie d'une composition pour créer une composition virtuelle du noiZetier possédant les mêmes caractéristiques (page=noizetier_page_edit).
autoriser_noisette_editer()  : bool
Autorisation d'édition d'une noisette déjà ajoutée dans le bloc d'une page ou d'un contenu (page=noisette_edit).
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.
noizetier_ieconfig()  : array<string|int, mixed>
Pipeline ieconfig pour l'import/export de configuration.
noizetier_ieconfig_exporter()  : array<string|int, mixed>
Retourne le tableau d'export du noiZetier contenant toujours sa configuration, les blocs exclus des pages explicites, la description complète des compositions virtuelles et la description complète des noisettes.
noizetier_ieconfig_importer()  : bool
Importe tout ou partie d'un fichier d'export ieconfig contenant les données du noiZetier.
noizetier_recuperer_fond()  : array<string|int, mixed>
Pipeline recuperer_fond pour ajouter les noisettes.
noizetier_styliser()  : array<string|int, mixed>
Pipeline styliser pour les compositions virtuelles du noizetier.
noizetier_compositions_lister_disponibles()  : array<string|int, mixed>
Pipeline compositions_lister_disponibles pour ajouter les compositions du noizetier.
noizetier_jqueryui_forcer()  : array<string|int, mixed>
Pipeline jqueryui_forcer pour demander au plugin l'insertion des scripts pour .sortable().
noizetier_noizetier_blocs_defaut()  : mixed
noizetier_noizetier_config_export()  : mixed
noizetier_noizetier_config_import()  : mixed
noizetier_formulaire_admin()  : mixed
noizetier_affiche_milieu()  : mixed
Ajouter du contenu au centre de la page sur les pages privées
noizetier_compagnon_messages()  : array<string|int, mixed>
Ajout de bulles de compagnon sur les pages de listing des pages et objets supportant des noisettes.
noizetier_pre_boucle()  : mixed
noizetier_insert_head_css()  : string
noizetier_insert_head()  : string
noizetier_formulaire_fond()  : array<string|int, mixed>
Modifier le tableau retourné par la fonction traiter ou effectuer des traitements supplémentaires.

Constants

Functions

action_activer_composition_dist()

Cette action permet d'activer de façon sécurisée l'utilisation de composition sur un type d'objet.

action_activer_composition_dist() : void

Cette action est réservée aux utilisateurs autorisés à configurer le plugin Compositions. Elle nécessite de passer le type d'objet concerné.

Tags
uses
compositions_objets_actives()
Return values
void

action_decaler_noisette_dist()

Cette action permet à l'utilisateur de déplacer une noisette d'un rang vers le haut ou vers le bas, de façon sécurisée.

action_decaler_noisette_dist() : void

Cette action est réservée aux utilisateurs autorisés à modifier la configuration de la page à laquelle est rattachée la noisette. Elle nécessite des arguments dont le sens et l'id de la noisette.

Tags
uses
conteneur_noizetier_decomposer()
uses
noisette_deplacer()
Return values
void

action_deplacer_noisette_dist()

Action déplacer une noisette en ajax

action_deplacer_noisette_dist() : void

Permet de déplacer une noisette avec n'importe quel rang, dans n'importe quel conteneur Met à jour les rangs des autres noisettes si nécessaire. Retourne du JSON.

Tags
Note

: cette action diffère de decaler_noisette.php qui permet de déplacer d'un unique rang, au sein du même conteneur

Return values
void

action_dupliquer_noisette_dist()

Cette action permet à l'utilisateur de copier, de façon sécurisée, une noisette donnée et sa descendance si celle-ci est un conteneur au rang suivant dans le même conteneur.

action_dupliquer_noisette_dist() : void

Cette action est réservée aux utilisateurs autorisés. Elle nécessite l'id de la noisette comme argument unique.

Tags
uses
conteneur_noizetier_decomposer()
uses
noisette_supprimer()
Return values
void

action_migrer_schema_070_dist()

Cette action permet à l'utilisateur de migrer le contenu de la base du schéma 0.6.0 au schéma 0.7.0, de façon sécurisée, Les types de noisette sont rechargés pour peupler le champ css_saisies et les noisettes sont mises à jour pour peupler le champ css_saisies et mettre à jour les champs paramètres et css des noisettes conteneur.

action_migrer_schema_070_dist() : void

Cette action est réservée aux utilisateurs pouvant utiliser le noiZetier. Elle ne nécessite aucun argument.

Return values
void

action_recharger_pages_dist()

Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, une page ou l'ensemble des pages à partir de leur fichier XML ou YAML.

action_recharger_pages_dist() : void

Cette action est réservée aux utilisateurs pouvant utiliser le noiZetier. Elle ne nécessite l'identifiant de la page ou vide si on veut recharger toutes les pages.

Return values
void

action_recharger_types_noisette_dist()

Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les types de noisette à partir de leur fichier YAML.

action_recharger_types_noisette_dist() : void

Cette action est réservée aux utilisateurs pouvant utiliser le noiZetier. Elle ne nécessite aucun argument.

Return values
void

action_supprimer_composition_dist()

Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, une composition virtuelle donnée.

action_supprimer_composition_dist() : void

Cette action est réservée aux webmestres. Elle nécessite en argument l'identifiant de la page.

Tags
uses
supprimer_noisettes()
Return values
void

action_supprimer_noisette_dist()

Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, une noisette donnée et sa descendance si celle-ci est un conteneur.

action_supprimer_noisette_dist() : void

Cette action est réservée aux utilisateurs autorisés. Elle nécessite l'id de la noisette comme argument unique.

Tags
uses
conteneur_noizetier_decomposer()
uses
noisette_supprimer()
Return values
void

action_vider_conteneur_dist()

Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, toutes les noisettes d'un conteneur qu'il soit un bloc ou une noisette.

action_vider_conteneur_dist() : void

Si le conteneur contient une noisette conteneur, sa descendance sera aussi supprimée.

Cette action est réservée aux utilisateurs autorisés. Elle nécessite l'id du conteneur comme argument unique.

Tags
uses
conteneur_noizetier_decomposer()
uses
conteneur_vider()
Return values
void

action_vider_page_dist()

Cette action permet à l'utilisateur de supprimer de sa base de données, de façon sécurisée, toutes les noisettes d'une page ou d'un objet.

action_vider_page_dist() : void

Les compositions de page explicites ou virtuelles (créée par le noizetier) sont aussi prises en compte.

Cette action est réservée aux utilisateurs autorisés. Elle nécessite des arguments dont la liste dépend du contexte.

Return values
void

noizetier_declarer_tables_interfaces()

Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.

noizetier_declarer_tables_interfaces(array<string|int, mixed> $interface) : array<string|int, mixed>

Le plugin se contente de déclarer les alias des tables et quelques traitements.

Parameters
$interface : array<string|int, mixed>

Tableau global des informations tierces sur les tables de la base de données

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Tableau fourni en entrée et mis à jour avec les nouvelles informations

noizetier_declarer_tables_principales()

Déclaration des nouvelles tables de la base de données propres au plugin.

noizetier_declarer_tables_principales(array<string|int, mixed> $tables_principales) : array<string|int, mixed>

Le plugin déclare trois nouvelles tables qui sont :

  • spip_noizetier_pages, qui contient les éléments descriptifs des pages et compositions,
  • spip_types_noisettes, qui contient les éléments descriptifs des types de noisette disponibles,
  • spip_noisettes, qui contient l'affectation des noisettes dans les pages concernées.
Parameters
$tables_principales : array<string|int, mixed>

Tableau global décrivant la structure des tables de la base de données

Tags
pipeline

declarer_tables_principales

Return values
array<string|int, mixed>

Tableau fourni en entrée et mis à jour avec les nouvelles déclarations

formulaires_ajouter_noisette_charger_dist()

Formulaire listant les noisettes incluses dans un conteneur de type (page, bloc), (objet, bloc) ou noisette conteneur.

formulaires_ajouter_noisette_charger_dist(array<string|int, mixed>|string $page_ou_objet, string $bloc[, array<string|int, mixed> $noisette = array() ][, string $redirect = '' ]) : array<string|int, mixed>

La fonction charger déclare les champs postés et y intègre les valeurs par défaut.

Parameters
$page_ou_objet : array<string|int, mixed>|string

Page au sens SPIP ou objet spécifiquement identifié.

  • dans le cas d'une page SPIP comme sommaire, l'argument est une chaîne.
  • dans le cas d'un objet SPIP comme un article d'id x, l'argument est un tableau associatif à deux index, objet et id_objet.
$bloc : string

Bloc de page au sens Z.

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

Tableau descriptif d'une noisette contenant à minima son type et son id.

$redirect : string = ''

URL de redirection. La valeur dépend du type d'édition.

Return values
array<string|int, mixed>

Tableau des champs postés pour l'affichage du formulaire.

formulaires_ajouter_noisette_verifier_dist()

formulaires_ajouter_noisette_verifier_dist(mixed $page_ou_objet, mixed $bloc[, mixed $noisette = array() ][, mixed $redirect = '' ]) : mixed
Parameters
$page_ou_objet : mixed
$bloc : mixed
$noisette : mixed = array()
$redirect : mixed = ''
Return values
mixed

formulaires_ajouter_noisette_traiter_dist()

formulaires_ajouter_noisette_traiter_dist(mixed $page_ou_objet, mixed $bloc[, mixed $noisette = array() ][, mixed $redirect = '' ]) : mixed
Parameters
$page_ou_objet : mixed
$bloc : mixed
$noisette : mixed = array()
$redirect : mixed = ''
Return values
mixed

formulaires_configurer_noizetier_charger_dist()

formulaires_configurer_noizetier_charger_dist() : mixed
Return values
mixed

formulaires_configurer_noizetier_traiter_dist()

formulaires_configurer_noizetier_traiter_dist() : mixed
Return values
mixed

lister_objets_exclus()

Renvoie la liste des types d'objet ne pouvant pas être personnalisés car ne possédant pas de page détectable par le noiZetier.

lister_objets_exclus() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

formulaires_editer_page_charger_dist()

Formulaire d'édition d'une page de composition de noisettes.

formulaires_editer_page_charger_dist(string $edition, string $page[, string $redirect = '' ]) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters
$edition : string

Type d'édition à savoir :

  • modifier: édition de la configuration de base d'une composition virtuelle
  • créer: création d'une composition virtuelle à partir d'une page source
  • dupliquer: copie d'une composition pour créer une nouvelle composition virtuelle
$page : string

L'identifiant de la page ou de la composition :

$redirect : string = ''

URL de redirection. La valeur dépend du type d'édition.

Return values
array<string|int, mixed>

Tableau des champs postés pour l'affichage du formulaire.

formulaires_editer_page_verifier_dist()

formulaires_editer_page_verifier_dist(string $edition, string $page[, string $redirect = '' ]) : array<string|int, mixed>
Parameters
$edition : string

Type d'édition à savoir :

  • modifier: édition de la configuration de base d'une composition virtuelle
  • créer: création d'une composition virtuelle à partir d'une page source
  • dupliquer: copie d'une composition pour créer une nouvelle composition virtuelle
$page : string

L'identifiant de la page ou de la composition :

  • modifier: la composition virtuelle en cours d'édition
  • créer: la page source
  • dupliquer: la composition source
$redirect : string = ''

URL de redirection. La valeur dépend du type d'édition.

Return values
array<string|int, mixed>

formulaires_editer_page_traiter_dist()

formulaires_editer_page_traiter_dist(string $edition, string $page[, string $redirect = '' ]) : array<string|int, mixed>
Parameters
$edition : string

Type d'édition à savoir :

  • modifier: édition de la configuration de base d'une composition virtuelle ou des blocs exclus d'une page
  • créer: création d'une composition virtuelle à partir d'une page source
  • dupliquer: copie d'une composition pour créer une nouvelle composition virtuelle
$page : string

L'identifiant de la page ou de la composition :

$redirect : string = ''

URL de redirection. La valeur dépend du type d'édition.

Return values
array<string|int, mixed>

construire_heritages()

Détermine les compositions héritables par le type de page et les héritages définis pour chaque type d'objet concerné par la composition désignée par $page.

construire_heritages(string $type[, string $page = '' ]) : array<string|int, mixed>
Parameters
$type : string

Type d'objet pouvant posséder des enfants.

$page : string = ''

Identifiant de la composition dont les héritages doivent être renvoyés.

Return values
array<string|int, mixed>

formulaires_etendre_noisette_charger_dist()

Formulaire listant les pages compatibles avec la noisette passée en argument et pouvant donc recevoir cette même noisette dans le bloc fourni en argument.

formulaires_etendre_noisette_charger_dist(int $noisette, mixed $page_noisette, string $bloc, string $redirect) : array<string|int, mixed>
Parameters
$noisette : int

Tableau des informations nécessaires sur la noisette à copier, à savoir, l'id et le type de noisette.

$page_noisette : mixed
$bloc : string

Bloc de page au sens Z.

$redirect : string

URL de redirection : on revient sur la page d'origine de l'action.

Return values
array<string|int, mixed>

Tableau des champs postés pour l'affichage du formulaire.

formulaires_etendre_noisette_verifier_dist()

formulaires_etendre_noisette_verifier_dist(mixed $noisette, mixed $page_noisette, mixed $bloc, mixed $redirect) : mixed
Parameters
$noisette : mixed
$page_noisette : mixed
$bloc : mixed
$redirect : mixed
Return values
mixed

formulaires_etendre_noisette_traiter_dist()

formulaires_etendre_noisette_traiter_dist(mixed $noisette, mixed $page_noisette, mixed $bloc, mixed $redirect) : mixed
Parameters
$noisette : mixed
$page_noisette : mixed
$bloc : mixed
$redirect : mixed
Return values
mixed

formulaires_lister_noisettes_bloc_charger_dist()

La fonction charger déclare les champs postés et y intègre les valeurs par défaut.

formulaires_lister_noisettes_bloc_charger_dist(array<string|int, mixed>|string $page_ou_objet, string $bloc) : array<string|int, mixed>
Parameters
$page_ou_objet : array<string|int, mixed>|string

Page au sens SPIP ou objet spécifiquement identifié.

  • dans le cas d'une page SPIP comme sommaire, l'argument est une chaîne.
  • dans le cas d'un objet SPIP comme un article d'id x, l'argument est un tableau associatif à deux index, objet et id_objet.
$bloc : string

Bloc de page au sens Z.

Return values
array<string|int, mixed>

Tableau des champs postés pour l'affichage du formulaire.

formulaires_lister_noisettes_bloc_traiter_dist()

formulaires_lister_noisettes_bloc_traiter_dist(array<string|int, mixed>|string $page_ou_objet, string $bloc) : array<string|int, mixed>
Parameters
$page_ou_objet : array<string|int, mixed>|string

Page au sens SPIP ou objet spécifiquement identifié.

  • dans le cas d'une page SPIP comme sommaire, l'argument est une chaîne.
  • dans le cas d'un objet SPIP comme un article d'id x, l'argument est un tableau associatif à deux index, objet et id_objet.
$bloc : string

Bloc de page au sens Z.

Return values
array<string|int, mixed>

Tableau des champs postés pour l'affichage du formulaire.

formulaires_preremplir_page_charger_dist()

Formulaire listant les pages compatibles permettant de pré-remplir la page ou le contenu vide en cours de configuration.

formulaires_preremplir_page_charger_dist(array<string|int, mixed>|string $page_ou_objet) : array<string|int, mixed>

Les pages compatibles sont celles dont le type est le même que celui de la page ou du contenu.

Parameters
$page_ou_objet : array<string|int, mixed>|string

Page au sens SPIP ou objet spécifiquement identifié.

  • dans le cas d'une page SPIP comme sommaire ou article, l'argument est une chaîne, l'identifiant de la page.
  • dans le cas d'un objet SPIP comme un article d'id x, l'argument est un tableau associatif à deux index, objet et id_objet.
Return values
array<string|int, mixed>

Tableau des champs postés pour l'affichage du formulaire.

formulaires_preremplir_page_verifier_dist()

formulaires_preremplir_page_verifier_dist(mixed $page_ou_objet) : mixed
Parameters
$page_ou_objet : mixed
Return values
mixed

formulaires_preremplir_page_traiter_dist()

formulaires_preremplir_page_traiter_dist(mixed $page_ou_objet) : mixed
Parameters
$page_ou_objet : mixed
Return values
mixed

bloc_noizetier_lister_defaut()

Renvoie la liste par défaut des identifiants des blocs d'une page.

bloc_noizetier_lister_defaut() : array<string|int, mixed>

Cette liste peut être modifiée via le pipeline noizetier_blocs_defaut, en particulier pour supprimer certains blocs pour l'ensemble des pages et objets.

Return values
array<string|int, mixed>

bloc_noizetier_lire()

Retourne la description complète ou une information particulière d'un bloc donné.

bloc_noizetier_lire(string $bloc[, string $information = '' ]) : array<string|int, mixed>|string

La description complète du bloc est inscrite dans un fichier YAML nommé bloc.yaml stocké dans le dossier du bloc concerné.

Parameters
$bloc : string

Identifiant du bloc, à savoir, le nom du dossier sous Z.

$information : string = ''

Champ précis à renvoyer ou cha^ne vide pour renvoyer tous les champs de l'objet.

Return values
array<string|int, mixed>|string

La description complète sous forme de tableau ou l'information précise demandée.

conteneur_noizetier_composer()

Détermine l'id du conteneur à partir des données d'une page, d'un objet ou d'une noisette conteneur.

conteneur_noizetier_composer(array<string|int, mixed>|string $page_ou_objet, string $bloc[, array<string|int, mixed> $noisette = array() ]) : string

Cette fonction est en fait une encapsalution de la fonction conteneur_identifier() qui permet de reconstituer le conteneur à partir des données du noizetier page, composition, objet et noisette.

Parameters
$page_ou_objet : array<string|int, mixed>|string

Page au sens SPIP ou objet spécifiquement identifié.

  • dans le cas d'une page SPIP comme sommaire, l'argument est une chaîne.
  • dans le cas d'un objet SPIP comme un article d'id x, l'argument est un tableau associatif à deux index, objet et id_objet.
$bloc : string

Bloc de page au sens Z.

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

Tableau descriptif d'une noisette contenant à minima son type et son id.

Tags
uses
conteneur_identifier()
Return values
string

conteneur_noizetier_decomposer()

Détermine à partir de l'id du conteneur les données propres au noiZetier, à savoir, la page, l'objet ou la noisette conteneur concernée.

conteneur_noizetier_decomposer(string $id_conteneur) : array<string|int, mixed>

Le tableau ainsi produit peut-être fourni aux autorisations concernant la manipulation des pages du noiZetier.

Parameters
$id_conteneur : string

Identifiant du conteneur sous forme de chaine unique.

Tags
uses
page_noizetier_extraire_type()
uses
page_noizetier_extraire_composition()
uses
type_noisette_localiser()
Return values
array<string|int, mixed>

objet_noizetier_lire()

Renvoie la description complète ou uniquement une information précise pour un objet donné.

objet_noizetier_lire(string $type_objet, string $id_objet[, string $information = '' ]) : mixed

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 : string

Id de l'objet.

$information : string = ''

Champ précis à renvoyer ou chaîne vide pour renvoyer toutes les champs de l'objet.

Return values
mixed

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 $objet, int $id_objet) : bool
Parameters
$objet : string

Le type d'objet comme article.

$id_objet : int

L'id de l'objet.

Return values
bool

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([array<string|int, mixed> $filtres = array() ]) : array<string|int, mixed>|string

Cette fonction est utilisable dans le public via la balise #OBJET_NOIZETIER_LISTE.

Parameters
$filtres : array<string|int, mixed> = array()

Liste des champs sur lesquels appliquer les filtres des objets.

Return values
array<string|int, mixed>|string

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

True 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 $objet, int $id_objet) : array<string|int, mixed>
Parameters
$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()

objet_noizetier_afficher_configuration(mixed $objet, mixed $id_objet) : mixed
Parameters
$objet : mixed
$id_objet : mixed
Return values
mixed

page_noizetier_charger()

page_noizetier_charger([bool $recharger = false ][, string $page_a_charger = '' ]) : bool
Parameters
$recharger : bool = false
$page_a_charger : string = ''
Return values
bool

page_noizetier_initialiser()

Initialise avec des valeurs par défaut la description d'une page connue par son identifiant.

page_noizetier_initialiser(string $page) : array<string|int, mixed>
Parameters
$page : string

Identifiant de la page

Return values
array<string|int, mixed>

La description initialisée.

page_noizetier_virtuelle_propager()

Propage éventuellement les modifications des pages non virtuelles vers les compositions virtuelles associées.

page_noizetier_virtuelle_propager(array<string|int, mixed> $pages) : void

La mise à jour concerne les plugins necessités et l'indicateur d'activité.

Parameters
$pages : array<string|int, mixed>

Tableau de la description complète des pages et compositions non virtuelles modifiées.

Return values
void

page_noizetier_lire()

Retourne la description complète de la page, de la composition explicite ou de la composition virtuelle demandée ou une information donnée uniquement.

page_noizetier_lire(string $page[, array<string|int, mixed>|string $informations = array() ][, bool $traiter_typo = false ]) : array<string|int, mixed>|string

La description est stockée en base de données, certains champs sont recalculés avant d'être fournis.

Parameters
$page : string

Identifiant de la page ou de la composition.

$informations : array<string|int, mixed>|string = array()

Liste des champs à renvoyer. Si vide la fonction renvoie tous les champs. Il est possible de demander un seul champ sous la forme d'une chaine et pas de tableau.

$traiter_typo : bool = false

Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées en utilisant la fonction typo. Les champs sérialisés sont toujours désérialisés.

Tags
uses
page_noizetier_lister_blocs()
Return values
array<string|int, mixed>|string

La description complète ou un champ précis demandé pour une page donnée. Les champs de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être traités avec la fonction typo().

page_noizetier_repertorier()

Retourne la description complète ou partielle d'une liste de pages explicites, compositions explicite et compositions virtuelles filtrées sur une liste de critères.

page_noizetier_repertorier([string $information = array() ][, array<string|int, mixed> $filtres = array() ][, bool $indexer_par_page = true ]) : array<string|int, mixed>
Parameters
$information : string = array()

Information spécifique à retourner ou vide pour retourner toute la description. L'information peut être une chaine correspondant à un champ de la page ou un tableau avec une liste de champs.

$filtres : array<string|int, mixed> = array()

Tableau associatif [champ] = valeur de critères de filtres sur les descriptions de types de noisette. Le seul opérateur possible est l'égalité.

$indexer_par_page : bool = true

Indique si le tableau doit être indexé par d'identifiant de page ou pas. true par défaut.

Return values
array<string|int, mixed>

Tableau des descriptions des pages et compositions trouvées indexé par l'identifiant de la page ou par entier de 0 à n.

page_noizetier_lister_blocs()

page_noizetier_lister_blocs( $page[, array<string|int, mixed> $blocs_exclus = array() ]) : array<string|int, mixed>
Parameters
$page :
$blocs_exclus : array<string|int, mixed> = array()
Return values
array<string|int, mixed>

page_noizetier_extraire_type()

Renvoie le type d'une page à partir de son identifiant.

page_noizetier_extraire_type(string $page) : string

On gère aussi le cas de Zpip v1 où page-xxxx désigne une page et non une composition. Dans ce cas, on doit donc obtenir un type = xxxx.

Parameters
$page : string

L'identifiant de la page.

Return values
string

Le type de la page choisie, c'est-à-dire:

  • soit l'identifiant complet de la page,
  • soit le mot précédent le tiret dans le cas d'une composition.

page_noizetier_extraire_composition()

Détermine, à partir de son identifiant, la composition d'une page si elle existe.

page_noizetier_extraire_composition(string $page) : string

On gère aussi le cas de Zpip v1 où page-xxxx désigne une page et non une composition. Dans ce cas, on doit donc obtenir une composition vide.

Parameters
$page : string

L'identifiant de la page.

Return values
string

La composition de la page choisie, à savoir, le mot suivant le premier le tiret, ou la chaine vide sinon.

page_noizetier_composition_activee()

Détermine si les compositions sont possibles sur un type de page.

page_noizetier_composition_activee(string $type) : bool
Parameters
$type : string

Identifiant du type de page.

Return values
bool

True si les compositions sont autorisées, false sinon.

page_noizetier_initialiser_dossier()

Déterminer le répertoire dans lequel le NoiZetier peut lister les pages pouvant supporter l'insertion de noisettes.

page_noizetier_initialiser_dossier() : string
Return values
string

Le répertoire des pages sous la forme dossier/.

page_noizetier_compter_noisettes()

Détermine, pour une page donnée, la liste des blocs ayant des noisettes incluses et renvoie leur nombre.

page_noizetier_compter_noisettes(string $page) : array<string|int, mixed>
Parameters
$page : string

L'identifiant de la page ou de la composition.

Return values
array<string|int, mixed>

Tableau des nombre de noisettes incluses par bloc de la forme [bloc] = nombre de noisettes.

compiler_traductions_idiome()

Compiler les traductions d'un idiome représentant le nom d'une page en une chaine multi.

compiler_traductions_idiome(string $idiome) : string
Parameters
$idiome : string
Return values
string

calculer_condition_par_filtre()

Construit le tableau des conditions au format compatible avec l'API SQL à partir du tableau des filtres au format [champ] = valeur.

calculer_condition_par_filtre([array<string|int, mixed> $filtres = array() ]) : array<string|int, mixed>
Parameters
$filtres : array<string|int, mixed> = array()

Tableau associatif [champ] = valeur de critères de filtres sur les descriptions de types de noisette. Les opérateurs binaires possibles sont l'égalité et l'inégalité en préfixant la valeur par le caractère `!``. Si la valeur est un tableau on génère un IN.

Return values
array<string|int, mixed>

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) : bool

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
bool

true si par défaut un type de noisette est insérée en ajax, false 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) : bool

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
bool

true si par défaut un type noisette est insérée en dynamique, false 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>|string $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>|string

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 = array() ][, string $information = '' ][, string $cle = 'rang_noisette' ]) : 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 = array()

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 = 'rang_noisette'

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, mixed $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 : mixed

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

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_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_recuperer_code()

recupere le resultat du calcul d'une compilation de code de squelette $coucou = $this->recuperer_code('[(#AUTORISER{ok}|oui)coucou]');

noizetier_recuperer_code(string $code[, array<string|int, mixed> $contexte = array() ][, mixed $options = array() ][, string $connect = '' ]) : mixed

Voir la fonction recuperer_fond pour les parametres

Parameters
$code : string

: code du squelette

$contexte : array<string|int, mixed> = array()

: contexte de calcul du squelette

$options : mixed = array()
$connect : string = ''

: nom de la connexion a la bdd

Return values
mixed

noizetier_upgrade()

Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.

noizetier_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le schéma comprend des tables et des variables de configuration propres au plugin.

Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

$version_cible : string

Version du schéma de données en fin d'upgrade

Return values
void

noizetier_vider_tables()

Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.

noizetier_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

Return values
void

maj_060()

Migration du schéma 0.5 au 0.6.

maj_060(array<string|int, mixed> $config_defaut) : void

Les actions effectuées sont les suivantes:

  • ajout de la tables spip_noisettes_pages pour stocker l'ensemble des pages et compositions explicites et virtuelles.
  • ajout du champ encapsulation à la table spip_noisettes pour déterminer si le noiZetier doit inclure la noisette concernée dans un div englobant et ajout du champ plugin pour étendre le stockage au-delà du noiZetier.
  • mise à jour de la taille des champs type, composition et objet dans la table spip_noisettes
  • ajout d'une liste de variables de configuration initialisées
  • transfert des compositions virtuelles de la meta noizetier_compositions dans la nouvelle table spip_noizetier_pages et suppression définitive de la meta.
Parameters
$config_defaut : array<string|int, mixed>

Tableau des variables de configuration intialisées.

Return values
void

maj_070()

Migration du schéma 0.6 au 0.7.

maj_070() : void

Les actions effectuées sont les suivantes:

  • ajout du champ css_saisies à la table spip_types_noisettes pour stocker les saisies qui permettent d'éditer les styles de la capsule ou de la noisette conteneur.
Return values
void

maj_080()

Migration du schéma 0.7 au 0.8.

maj_080() : void

Les actions effectuées sont les suivantes:

  • ajout du champ groupes à la table spip_types_noisettes pour stocker affectations des paramètres à des groupes représentés par des fieldsets ou des onglets dans le formulaire d'édition
  • rechargement des types de noisettes pour initialiser ce nouveau champ.
Return values
void

maj_090()

Migration du schéma 0.8 au 0.9.

maj_090() : void

Les actions effectuées sont les suivantes:

  • ajout du champ categories à la table spip_types_noisettes
  • rechargement des types de noisettes pour initialiser ce nouveau champ.
Return values
void

autoriser_noizetier_dist()

Autorisation minimale d'accès à toutes les pages du noiZetier sauf celle de configuration du plugin lui-même.

autoriser_noizetier_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Par défaut, seuls les administrateurs complets sont autorisés à utiliser le noiZetier. Cette autorisation est à la base de la plupart des autres autorisations du plugin.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_menu_dist()

Autorisation d'affichage du menu d'accès à la configuration du noiZetier (page=noizetier_pages).

autoriser_noizetier_menu_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut être autorisé à configurer le noiZetier.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_configurer_dist()

Autorisation d'accès à la page de configuration du plugin noiZetier (page=configurer_noizetier).

autoriser_noizetier_configurer_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Par défaut, seuls les webmestres sont autorisés à modifier la configuration du noiZetier et en particulier la liste des pages accessibles par les autres utilisateurs.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_configurerpage_dist()

Autorisation de configuration d'une page ou d'un objet du noiZetier (page=noizetier_page).

autoriser_noizetier_configurerpage_dist(string $faire, string|null $type, string|int|null $id, null|int|array<string|int, mixed> $qui, array<string|int, mixed> $options) : bool

La configuration consiste dans tous les cas à manipuler les noisettes des divers blocs de la page et si la page est une composition virtuelle à éditer ses caractéristiques (page=noizetier_page_edit). Il faut :

  • être autorisé à configurer le noiZetier,
  • que la page ou l'objet existe et soit bien accessible pour le noiZetier (i.e. plugin Compositions actif si on est en présence d'une composition),
  • et que :
    • si on est en présence d'un objet, son type soit bien activé dans la configuration,
    • ou que si on est en présence d'une composition basée sur un type d'objet, celui-ci soit bien activé.
Parameters
$faire : string

L'action se nomme configurerpage

$type : string|null

Le type est toujours noizetier.

$id : string|int|null

Inutilisé car l'identifiant représente soit la page soit l'objet (forcer null)

$qui : null|int|array<string|int, mixed>

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page ou de l'objet concerné sous la forme d'un tableau associatif dont les index sont 'page' ou 'objet' et 'id_objet'.

Return values
bool

autoriser_noizetier_activercomposition_dist()

Autorisation d'activation des compositions sur un type d'objet. Permet de lancer l'action depuis le noiZetier sans passer par la configuration du plugin Compositions.

autoriser_noizetier_activercomposition_dist(string $faire, string|null $type, string|int|null $id, null|int|array<string|int, mixed> $qui, array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à configurer le noiZetier
  • que la page source existe et ne soit pas une composition
  • que le plugin Compositions soit bien activé
  • que l'utilisateur soit autorisé à configurer le plugin Compositions
  • et que la page soit celle d'un type d'objet et que les compositions ne soient pas déjà activées.
Parameters
$faire : string

L'action se nomme activercomposition

$type : string|null

Le type est toujours noizetier.

$id : string|int|null

Inutilisé car l'identifiant représente soit la page (forcer null)

$qui : null|int|array<string|int, mixed>

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page concernée sous la forme d'un tableau associatif dont l'index 'page'.

Return values
bool

autoriser_noizetier_creercomposition_dist()

Autorisation de création d'une composition virtuelle du noiZetier à partir d'une page source (page=noizetier_page_edit).

autoriser_noizetier_creercomposition_dist(string $faire, string|null $type, string|int|null $id, null|int|array<string|int, mixed> $qui, array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à configurer le noiZetier
  • que la page source existe et ne soit pas une composition
  • que le plugin Compositions soit bien activé
  • et que si la page est celle d'un type d'objet, que les compositions soient bien activées.
Parameters
$faire : string

L'action se nomme creercomposition

$type : string|null

Le type est toujours noizetier.

$id : string|int|null

Inutilisé car l'identifiant représente soit la page (forcer null)

$qui : null|int|array<string|int, mixed>

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page concernée sous la forme d'un tableau associatif dont l'index 'page'.

Return values
bool

autoriser_noizetier_supprimercomposition_dist()

Autorisation de suppression d'une composition virtuelle du noiZetier.

autoriser_noizetier_supprimercomposition_dist(string $faire, string|null $type, string|int|null $id, null|int|array<string|int, mixed> $qui, array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à configurer la page concernée (pour la suppression des noisettes)
  • et que la page existe toujours et soit bien une composition virtuelle.
Parameters
$faire : string

L'action se nomme supprimercomposition

$type : string|null

Le type est toujours noizetier.

$id : string|int|null

Inutilisé car l'identifiant représente soit la page (forcer null)

$qui : null|int|array<string|int, mixed>

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page concernée sous la forme d'un tableau associatif dont l'index 'page'.

Return values
bool

autoriser_noizetier_modifierpage_dist()

Autorisation de modification certains paramètres d'une page (page=noizetier_page_edit). Suivant que la page est une page explicite ou une composition virtuelle la liste des paramètres éditables varie.

autoriser_noizetier_modifierpage_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut être autorisé à configurer la page.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_dupliquercomposition_dist()

Autorisation de copie d'une composition pour créer une composition virtuelle du noiZetier possédant les mêmes caractéristiques (page=noizetier_page_edit).

autoriser_noizetier_dupliquercomposition_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut :

  • être autorisé à configurer le noiZetier
  • que la page source existe et soit une composition
  • et que le plugin Compositions soit bien activé.
Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noisette_editer()

Autorisation d'édition d'une noisette déjà ajoutée dans le bloc d'une page ou d'un contenu (page=noisette_edit).

autoriser_noisette_editer( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut :

  • ne pas être dans un mode de migration des noisettes (du à un upgrade des tables du plugin)
  • que la noisette existe bien,
  • et être autorisé à configurer la page ou le contenu auquel est rattachée la noisette
Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

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)
Return values
void

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 '='.

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.

noizetier_ieconfig()

Pipeline ieconfig pour l'import/export de configuration.

noizetier_ieconfig(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

noizetier_ieconfig_exporter()

Retourne le tableau d'export du noiZetier contenant toujours sa configuration, les blocs exclus des pages explicites, la description complète des compositions virtuelles et la description complète des noisettes.

noizetier_ieconfig_exporter() : array<string|int, mixed>
Return values
array<string|int, mixed>

Tableau d'export pour le pipeline ieconfig_exporter.

noizetier_ieconfig_importer()

Importe tout ou partie d'un fichier d'export ieconfig contenant les données du noiZetier.

noizetier_ieconfig_importer(array<string|int, mixed> $importation, array<string|int, mixed> $contenu_import) : bool
Parameters
$importation : array<string|int, mixed>

Tableau associatif des demandes d'importation issues du formulaire ieconfig. Les index et les valeurs possibles sont :

  • configuration : vaut on pour importer ou null sinon
  • pages_explicites : vaut on pour importer ou null sinon
  • compositions_virtuelles : vaut remplacer, ajouter ou fusionner pour importer ou null sinon.
  • noisettes : vaut remplacer ou ajouter pour importer ou null sinon.
$contenu_import : array<string|int, mixed>

Tableau des données du noiZetier issues du fichier d'import.

Return values
bool

noizetier_recuperer_fond()

Pipeline recuperer_fond pour ajouter les noisettes.

noizetier_recuperer_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

noizetier_styliser()

Pipeline styliser pour les compositions virtuelles du noizetier.

noizetier_styliser(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

noizetier_compositions_lister_disponibles()

Pipeline compositions_lister_disponibles pour ajouter les compositions du noizetier.

noizetier_compositions_lister_disponibles(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

noizetier_jqueryui_forcer()

Pipeline jqueryui_forcer pour demander au plugin l'insertion des scripts pour .sortable().

noizetier_jqueryui_forcer(array<string|int, mixed> $plugins) : array<string|int, mixed>
Parameters
$plugins : array<string|int, mixed>
Return values
array<string|int, mixed>

noizetier_noizetier_blocs_defaut()

noizetier_noizetier_blocs_defaut( $flux) : mixed
Parameters
$flux :
Return values
mixed

noizetier_noizetier_config_export()

noizetier_noizetier_config_export( $flux) : mixed
Parameters
$flux :
Return values
mixed

noizetier_noizetier_config_import()

noizetier_noizetier_config_import( $flux) : mixed
Parameters
$flux :
Return values
mixed

noizetier_formulaire_admin()

noizetier_formulaire_admin( $flux) : mixed
Parameters
$flux :
Return values
mixed

noizetier_affiche_milieu()

Ajouter du contenu au centre de la page sur les pages privées

noizetier_affiche_milieu( $flux) : mixed

Page d'adminisration des plugin : on supprime le cache des noisettes. C'est un peu grossier mais pas trouvé de pipeline pour agir à la mise à jour d'un plugin. Au moins, le cache est supprimé à chaque changement, mise à jour des plugins.

Page d'un objet : inclure le squelette qui affiche un lien pour configurer les noisettes.

Parameters
$flux :
Return values
mixed

noizetier_compagnon_messages()

Ajout de bulles de compagnon sur les pages de listing des pages et objets supportant des noisettes.

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

Données du pipeline

Return values
array<string|int, mixed>

Données du pipeline mises à jour

noizetier_pre_boucle()

noizetier_pre_boucle( $boucle) : mixed
Parameters
$boucle :
Return values
mixed

noizetier_insert_head_css()

noizetier_insert_head_css( $flux) : string
Parameters
$flux :
Return values
string

noizetier_insert_head()

noizetier_insert_head( $flux) : string
Parameters
$flux :
Return values
string

noizetier_formulaire_fond()

Modifier le tableau retourné par la fonction traiter ou effectuer des traitements supplémentaires.

noizetier_formulaire_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Édition de la composition d'un objet : recharger le bloc des noisettes en ajax
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results