SPIP Code

Documentation du code de SPIP et de ses plugins

noiZetier

Application

Table of Contents

Constants

_DIR_CODE  = \_DIR_CACHE . 'recuperer_code/'

Functions

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.
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>
Charger le formulaire : le formulaire liste les noisettes incluses dans un conteneur de type (page, bloc), (objet, bloc) ou noisette conteneur.
formulaires_ajouter_noisette_verifier_dist()  : array<string|int, mixed>
Vérifier les saisies : on doit toujours choisir un type de noisette.
formulaires_ajouter_noisette_traiter_dist()  : array<string|int, mixed>
Exécuter les traitements : ajout de la noisette dans le conteneur.
formulaires_configurer_noizetier_charger_dist()  : array<string|int, mixed>
Charger le formulaire : déclare les champs postés et y intègre les valeurs par défaut.
formulaires_configurer_noizetier_traiter_dist()  : array<string|int, mixed>
Exécuter les traitements : supprimer éventuellement certains caches en fonction des saisies.
lister_objets_exclus()  : array<string|int, mixed>
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>
Charger le formulaire : formulaire d'édition d'une page de composition de noisettes.
formulaires_editer_page_verifier_dist()  : array<string|int, mixed>
Vérifier les saisies : champs obligatoires, identifiant déjà utilisé.
formulaires_editer_page_traiter_dist()  : array<string|int, mixed>
Exécuter les traitements : enregistrer les modifications de la page.
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>
Charger le formulaire : le formulaire liste 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()  : array<string|int, mixed>
Vérifier les saisies : on doit toujours choisir une page.
formulaires_etendre_noisette_traiter_dist()  : array<string|int, mixed>
Exécuter les traitements : dupliquer la noisette dans les pages choisies.
formulaires_preremplir_page_charger_dist()  : array<string|int, mixed>
Charger le formulaire : le formulaire liste les pages compatibles permettant de pré-remplir la page ou le contenu vide en cours de configuration. Les pages compatibles sont celles dont le type est le même que celui de la page ou du contenu.
formulaires_preremplir_page_verifier_dist()  : array<string|int, mixed>
Vérifier les saisies : on doit toujours choisir une page source.
formulaires_preremplir_page_traiter_dist()  : array<string|int, mixed>
Exécuter les traitements : dupliquer les noisettes de la page source choisie vers la page destination.
noizetier_noisette_changer_conteneur()  : array<string|int, mixed>
Transfère une noisette d'un conteneur vers un autre à un rang donné.
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).
calculer_critere_categories()  : string
Renvoie la condition SQL correspondant à l'utilisation du critère `categories`.
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 non détectées nativement par le plugin Compositions.
noizetier_jqueryui_forcer()  : array<string|int, mixed>
Pipeline jqueryui_forcer pour demander au plugin l'insertion des scripts pour .sortable().
noizetier_formulaire_admin()  : array<string|int, mixed>
noizetier_affiche_milieu()  : array<string|int, 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()  : Boucle
noizetier_insert_head_css()  : string
Insertion des css du noiZetier pour l'édition avec le mode voir_noisettes.
noizetier_insert_head()  : string
Permet d’ajouter des contenus dans la partie `<head>` des pages de l’espace public.
noizetier_formulaire_fond()  : array<string|int, mixed>
Modifier le tableau retourné par la fonction traiter ou effectuer des traitements supplémentaires.

Constants

Functions

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> $interfaces) : array<string|int, mixed>

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

Parameters
$interfaces : 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) : 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 : 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()

Charger le formulaire : le formulaire liste 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[, null|array<string|int, mixed> $noisette = [] ][, null|string $redirect = '' ]) : array<string|int, mixed>

La fonction 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 : null|array<string|int, mixed> = []

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

$redirect : null|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()

Vérifier les saisies : on doit toujours choisir un type de noisette.

formulaires_ajouter_noisette_verifier_dist(array<string|int, mixed>|string $page_ou_objet, string $bloc[, null|array<string|int, mixed> $noisette = [] ][, null|string $redirect = '' ]) : 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.

$noisette : null|array<string|int, mixed> = []

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

$redirect : null|string = ''

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

Return values
array<string|int, mixed> —

Tableau des erreurs ou vide si aucune erreur.

formulaires_ajouter_noisette_traiter_dist()

Exécuter les traitements : ajout de la noisette dans le conteneur.

formulaires_ajouter_noisette_traiter_dist(array<string|int, mixed>|string $page_ou_objet, string $bloc[, null|array<string|int, mixed> $noisette = [] ][, null|string $redirect = '' ]) : 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.

$noisette : null|array<string|int, mixed> = []

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

$redirect : null|string = ''

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

Return values
array<string|int, mixed> —

Tableau des messages de bon traitement ou d'erreur.

formulaires_configurer_noizetier_charger_dist()

Charger le formulaire : déclare les champs postés et y intègre les valeurs par défaut.

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

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

formulaires_configurer_noizetier_traiter_dist()

Exécuter les traitements : supprimer éventuellement certains caches en fonction des saisies.

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

Tableau des messages de bon traitement ou d'erreur.

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>
Return values
array<string|int, mixed> —

Liste des types d'objet

formulaires_editer_page_charger_dist()

Charger le formulaire : formulaire d'édition d'une page de composition de noisettes.

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

La fonction déclarer les champs postés et y intègre 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 : null|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()

Vérifier les saisies : champs obligatoires, identifiant déjà utilisé.

formulaires_editer_page_verifier_dist(string $edition, string $page[, null|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.

$redirect : null|string = ''

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

Return values
array<string|int, mixed> —

Tableau des erreurs ou vide si aucune erreur.

formulaires_editer_page_traiter_dist()

Exécuter les traitements : enregistrer les modifications de la page.

formulaires_editer_page_traiter_dist(string $edition, string $page[, null|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.

$redirect : null|string = ''

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

Return values
array<string|int, mixed> —

Tableau des messages de bon traitement ou d'erreur.

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[, null|string $page = '' ]) : array<string|int, mixed>
Parameters
$type : string

Type d'objet pouvant posséder des enfants.

$page : null|string = ''

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

Return values
array<string|int, mixed> —

Tableau des héritages

formulaires_etendre_noisette_charger_dist()

Charger le formulaire : le formulaire liste 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(array<string|int, mixed> $noisette, string $id_page, string $bloc, string $redirect) : array<string|int, mixed>

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

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

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

$id_page : string

Identifiant de la page

$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()

Vérifier les saisies : on doit toujours choisir une page.

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

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

$id_page : string

Identifiant de la page

$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 erreurs ou vide si aucune erreur.

formulaires_etendre_noisette_traiter_dist()

Exécuter les traitements : dupliquer la noisette dans les pages choisies.

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

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

$id_page : string

Identifiant de la page

$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 messages de bon traitement ou d'erreur.

formulaires_preremplir_page_charger_dist()

Charger le formulaire : le formulaire liste les pages compatibles permettant de pré-remplir la page ou le contenu vide en cours de configuration. Les pages compatibles sont celles dont le type est le même que celui de la page ou du contenu.

formulaires_preremplir_page_charger_dist(array<string|int, mixed>|string $page_ou_objet) : 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 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()

Vérifier les saisies : on doit toujours choisir une page source.

formulaires_preremplir_page_verifier_dist(array<string|int, mixed>|string $page_ou_objet) : 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 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 erreurs ou vide si aucune erreur.

formulaires_preremplir_page_traiter_dist()

Exécuter les traitements : dupliquer les noisettes de la page source choisie vers la page destination.

formulaires_preremplir_page_traiter_dist(array<string|int, mixed>|string $page_ou_objet) : 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 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 messages de bon traitement ou 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_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

Tags
@return

string/array : page compilee et calculee

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

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

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.

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.

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.

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.

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(mixed $faire, mixed $type, mixed $id, mixed $qui, mixed $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 : mixed
$type : mixed
$id : mixed
$qui : mixed
$options : mixed
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(mixed $faire, mixed $type, mixed $id, mixed $qui, mixed $options) : bool

Il faut être autorisé à configurer le noiZetier.

Parameters
$faire : mixed
$type : mixed
$id : mixed
$qui : mixed
$options : mixed
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(mixed $faire, mixed $type, mixed $id, mixed $qui, mixed $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 : mixed
$type : mixed
$id : mixed
$qui : mixed
$options : mixed
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, null|string $type, null|int|string $id, null|array<string|int, mixed>|int $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 : null|string

Le type est toujours noizetier.

$id : null|int|string

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

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

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, null|string $type, null|int|string $id, null|array<string|int, mixed>|int $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 : null|string

Le type est toujours noizetier.

$id : null|int|string

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

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

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, null|string $type, null|int|string $id, null|array<string|int, mixed>|int $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 : null|string

Le type est toujours noizetier.

$id : null|int|string

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

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

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, null|string $type, null|int|string $id, null|array<string|int, mixed>|int $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 : null|string

Le type est toujours noizetier.

$id : null|int|string

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

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

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(mixed $faire, mixed $type, mixed $id, mixed $qui, mixed $options) : bool

Il faut être autorisé à configurer la page.

Parameters
$faire : mixed
$type : mixed
$id : mixed
$qui : mixed
$options : mixed
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(mixed $faire, mixed $type, mixed $id, mixed $qui, mixed $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 : mixed
$type : mixed
$id : mixed
$qui : mixed
$options : mixed
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(mixed $faire, mixed $type, mixed $id, mixed $qui, mixed $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 : mixed
$type : mixed
$id : mixed
$qui : mixed
$options : mixed
Return values
bool

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_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>

Flux en entrée du pipeline

Return values
array<string|int, mixed> —

Flux mis à jour avec les saisies adéquates

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 —

truesi l'importation s'est bien passée, false sinon.

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 non détectées nativement par le plugin Compositions.

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

Le noiZetier rajoute :

  • les compositions virtuelles qui n'ont ni fichier YAML ni fichier HTML
  • les compositions réelles qui n'ont qu'un fichier YAML de description et pas de XML détectable par le plugin Compositions
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_formulaire_admin()

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

noizetier_affiche_milieu()

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

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

Page d'adminisration des plugins : 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 ou mise à jour des plugins.

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

Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, 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 $boucle) : Boucle
Parameters
$boucle : Boucle

Description de la boucle.

Return values
Boucle —

Description complétée de la boucle.

noizetier_insert_head_css()

Insertion des css du noiZetier pour l'édition avec le mode voir_noisettes.

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

Code html des styles CSS à charger

Tags
pipeline

insert_head_css

Return values
string —

Code html complété.

noizetier_insert_head()

Permet d’ajouter des contenus dans la partie `<head>` des pages de l’espace public.

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

Contenu HTML du header

Tags
pipeline

insert_head

Return values
string —

Code html complété.

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 : ajouter le sous-bloc des liens pour le noizetier
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results