SPIP Code

Documentation du code de SPIP et de ses plugins

SVP Typologie

Application

Table of Contents

Functions

action_affecter_plugin_dist()  : void
Action pour affecter un type de plugin à un plugin.
action_desaffecter_plugin_dist()  : void
Action pour désaffecter un type de plugin d'un plugin.
action_supprimer_export_dist()  : void
Supprimer un fichier d'export JSON (catégories, affectations).
action_telecharger_export_dist()  : void
Télécharger un fichier d'export JSON (catégories, affectations).
svptype_declarer_tables_objets_sql()  : array<string|int, mixed>
Ajouter le champ `identifiant` à la table des mots.
svptype_declarer_tables_auxiliaires()  : array<string|int, mixed>
Déclarations des tables auxilliaires nécessaires au plugin : - plugins_typologies, liens entre plugins et types de plugin.
svptype_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.
formulaires_editer_affectations_charger()  : array<string|int, mixed>
Chargement du formulaire d'affectation d'un type de plugin à un plugin donné.
formulaires_editer_affectations_traiter()  : array<string|int, mixed>
Traitement du formulaire d'affectation d'un type de plugin à un plugin donné.
formulaires_exporter_typologie_charger()  : array<string|int, mixed>
Chargement des données : le formulaire sert à tout type d'exportation. Il est donc nécessaire de construire le choix d'exportation entre les types de plugins ou leurs affectations.
formulaires_exporter_typologie_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir d'exporter les types de plugin ou leurs affectations.
formulaires_exporter_typologie_traiter()  : array<string|int, mixed>
Exécution du formulaire : les types sont exportés dans un fichier JSON dont le format est compatible avec celui de l'importation. Le fichier est créé dans un sous-répertoire de `_DIR_TMP`.
formulaires_importer_typologie_charger()  : array<string|int, mixed>
Chargement des données : le formulaire sert à tout type d'importation. Il est donc nécessaire de construire le choix d'exportation entre les types de plugins ou leurs affectations.
formulaires_importer_typologie_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir un fichier d'import de type JSON.
formulaires_importer_typologie_traiter()  : array<string|int, mixed>
Exécution du formulaire : le fichier choisi est décodé et les types de plugin ou les affectations sont chargés en base si il ne sont pas déjà présents.
formulaires_vider_typologie_charger()  : array<string|int, mixed>
Chargement des données : le formulaire sert à vider les types de plugin ou leurs affacteations. Il est donc nécessaire de construire les libellés des cases à cocher idoines.
formulaires_vider_typologie_traiter()  : array<string|int, mixed>
Exécution du formulaire : vidage des affectations et/ou des types de plugins (dans cet ordre si les deux sont sélectionnés).
selection_type_plugin_peupler()  : array<string|int, mixed>
Lister les types de plugins d'une typologie donnée pourl'afficher dans une saisie.
svptype_upgrade()  : void
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
svptype_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.
svptype_autoriser()  : mixed
autoriser_typologie_dist()  : bool
Autorisation minimale d'accès à toutes les pages ds SVP Typologie.
autoriser_typeplugin_supprimer_dist()  : bool
Autorisation de supprimer un type de plugin.
autoriser_typeplugin_modifier_dist()  : bool
Autorisation de modifier un type de plugin.
autoriser_typeplugin_creer_dist()  : bool
Autorisation de créer un type de plugin.
autoriser_plugin_affecter_dist()  : bool
Autorisation, pour un plugin, de lui affecter un type de plugin, de lui supprimer ou de lui modifier une affectation existante.
autoriser_typologie_menu_dist()  : bool
Autorisation d'affichage du menu d'accès à gestion des typologies de plugin (page=svptype_typologie).
svptype_formulaire_fond()  : array<string|int, mixed>
Modifie les champs du formulaire d'édition (création ou modification) d'un mot.
svptype_formulaire_verifier()  : array<string|int, mixed>
Vérifie la saisie du formulaire d'édition d'un mot plugin.
svptype_pre_insertion()  : array<string|int, mixed>
Insère des modifications juste avant la création d'un mot plugin (catégorie ou tag).
svptype_pre_edition()  : array<string|int, mixed>
Insère des modifications lors de l'édition de mots.
svptype_pre_boucle()  : Boucle
Exclure les groupes de mots et les mots-clés relatifs à une typologie de plugin si le critère typologie_plugin n'est pas explicitement utilisé.
svptype_afficher_contenu_objet()  : array<string|int, mixed>
Ajoute le champs identifiant dans l'affichage d'un mot plugin.
svptype_affiche_milieu()  : array<string|int, mixed>
Utilisation du pipeline affiche milieu.
svptype_affiche_droite()  : array<string|int, mixed>
Insertion dans le pipeline affiche_gauche Affiche la liste des plugins appartenant à la même catégorie.
svptype_liste_ezcollection()  : array<string|int, mixed>
Déclare de nouvelles collections (les typologies, les affectations) et met à jour les collections existantes déjà déclarées par SVP API (plugins).
svptype_post_ezcollection()  : array<string|int, mixed>
Complète la collection après son calcul standard.
svptype_post_ezressource()  : array<string|int, mixed>
Complète la collection après son calcul standard.

Functions

action_affecter_plugin_dist()

Action pour affecter un type de plugin à un plugin.

action_affecter_plugin_dist([null|string $arguments = null ]) : void

Cette action est réservée aux utilisateurs pouvant affecter un type de plugin. L'argument attendu est id_mot_actuel:prefixe:id_mot:typologie.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
plugin_desaffecter_type_plugin()
uses
plugin_affecter_type_plugin()

action_desaffecter_plugin_dist()

Action pour désaffecter un type de plugin d'un plugin.

action_desaffecter_plugin_dist([null|string $arguments = null ]) : void

Cette action est réservée aux utilisateurs pouvant affecter un type de plugin. L'argument attendu est prefixe:id_mot.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
plugin_desaffecter_type_plugin()

action_supprimer_export_dist()

Supprimer un fichier d'export JSON (catégories, affectations).

action_supprimer_export_dist() : void

Cette action est réservée aux utilisateurs pouvant accéder à toutes les pages ds SVP Typologie. Elle ne nécessite aucun argument.

action_telecharger_export_dist()

Télécharger un fichier d'export JSON (catégories, affectations).

action_telecharger_export_dist() : void

Cette action est réservée aux utilisateurs pouvant accéder à toutes les pages ds SVP Typologie. Elle ne nécessite aucun argument.

svptype_declarer_tables_objets_sql()

Ajouter le champ `identifiant` à la table des mots.

svptype_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>

Ce champ est une chaine sans espace qui représente un id textuel unique (l'unicité se définit au sein d'un groupe de mots).

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

Description des tables de la base.

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed> —

Description des tables de la base complétée par celles du plugin.

svptype_declarer_tables_auxiliaires()

Déclarations des tables auxilliaires nécessaires au plugin : - plugins_typologies, liens entre plugins et types de plugin.

svptype_declarer_tables_auxiliaires(array<string|int, mixed> $tables) : array<string|int, mixed>
Parameters
$tables : array<string|int, mixed>

Liste des tables auxillaires

Tags
pipeline

declarer_tables_auxiliaires

Return values
array<string|int, mixed> —

Liste des tables auxillaires mises à jour.

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

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

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

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

formulaires_editer_affectations_charger()

Chargement du formulaire d'affectation d'un type de plugin à un plugin donné.

formulaires_editer_affectations_charger(int $id_plugin, string $typologie[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$id_plugin : int

Identifiant unique du plugin

$typologie : string

Identifiant de la typologie

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

Options de chargement du formulaire :

Return values
array<string|int, mixed> —

Variables de contexte en entrée du formulaire

formulaires_editer_affectations_traiter()

Traitement du formulaire d'affectation d'un type de plugin à un plugin donné.

formulaires_editer_affectations_traiter(int $id_plugin, string $typologie[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$id_plugin : int

Identifiant unique du plugin

$typologie : string

Identifiant de la typologie

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

Options de chargement du formulaire :

Return values
array<string|int, mixed> —

Tableau des messages à afficher sur le formulaire

formulaires_exporter_typologie_charger()

Chargement des données : le formulaire sert à tout type d'exportation. Il est donc nécessaire de construire le choix d'exportation entre les types de plugins ou leurs affectations.

formulaires_exporter_typologie_charger(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie ou tag...

Return values
array<string|int, mixed> —

Tableau des données à charger par le formulaire (affichage) :

  • _vues : (affichage) choix d'exportation entre les types de plugin ou leurs affectations.
  • _vue_defaut : choix par défaut (types de plugin).

formulaires_exporter_typologie_verifier()

Vérification des saisies : il est indispensable de choisir d'exporter les types de plugin ou leurs affectations.

formulaires_exporter_typologie_verifier(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie ou tag.

Return values
array<string|int, mixed> —

Tableau des erreurs concernant le choix de la vue qui est obligatoire.

formulaires_exporter_typologie_traiter()

Exécution du formulaire : les types sont exportés dans un fichier JSON dont le format est compatible avec celui de l'importation. Le fichier est créé dans un sous-répertoire de `_DIR_TMP`.

formulaires_exporter_typologie_traiter(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie ou tag...

Return values
array<string|int, mixed> —

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

formulaires_importer_typologie_charger()

Chargement des données : le formulaire sert à tout type d'importation. Il est donc nécessaire de construire le choix d'exportation entre les types de plugins ou leurs affectations.

formulaires_importer_typologie_charger(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie, tag...

Return values
array<string|int, mixed> —

Tableau des données à charger par le formulaire (affichage) :

  • _vues : (affichage) choix d'exportation entre les types de plugin ou leurs affectations.

formulaires_importer_typologie_verifier()

Vérification des saisies : il est indispensable de choisir un fichier d'import de type JSON.

formulaires_importer_typologie_verifier(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie, tag...

Return values
array<string|int, mixed> —

Tableau des erreurs concernant le fichier ou tableau vide si aucune erreur.

formulaires_importer_typologie_traiter()

Exécution du formulaire : le fichier choisi est décodé et les types de plugin ou les affectations sont chargés en base si il ne sont pas déjà présents.

formulaires_importer_typologie_traiter(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie, tag...

Return values
array<string|int, mixed> —

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

formulaires_vider_typologie_charger()

Chargement des données : le formulaire sert à vider les types de plugin ou leurs affacteations. Il est donc nécessaire de construire les libellés des cases à cocher idoines.

formulaires_vider_typologie_charger(string $typologie) : array<string|int, mixed>

Le choix des affectations est toujours proposé mais pas celui des types de plugin qui ne peuvent être supprimés que si aucune affectation n'existe.

Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie, tag...

Return values
array<string|int, mixed> —

Tableau des données à charger par le formulaire :

  • _label_liste : (affichage) choix d'exportation entre les types de plugin ou leurs affectations.
  • _label_affectation : (affichage) indique que des affectations existent pour la typologie.
  • _nb_affectations : (affichage) permet d'afficher ou de masquer le choix des types de plugin en JS

formulaires_vider_typologie_traiter()

Exécution du formulaire : vidage des affectations et/ou des types de plugins (dans cet ordre si les deux sont sélectionnés).

formulaires_vider_typologie_traiter(string $typologie) : array<string|int, mixed>
Parameters
$typologie : string

Typologie de plugin concernée. Prend les valeurs categorie, tag...

Return values
array<string|int, mixed> —

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

selection_type_plugin_peupler()

Lister les types de plugins d'une typologie donnée pourl'afficher dans une saisie.

selection_type_plugin_peupler(string $typologie[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$typologie : string

Identifiant de la typologie concernée : categorie, tag...

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

Options d'affichage de la liste

Return values
array<string|int, mixed> —

Liste des types de plugins de la typologie concernée à afficher

svptype_upgrade()

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

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

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

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

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

svptype_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

autoriser_typologie_dist()

Autorisation minimale d'accès à toutes les pages ds SVP Typologie.

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

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

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

autoriser_typeplugin_supprimer_dist()

Autorisation de supprimer un type de plugin.

autoriser_typeplugin_supprimer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Un type de plugin est un mot-cle technique pouvant être arborescent ou pas ce qui implique de vérifier :

  • l'autorisation minimale de typologie
  • l'autorisation de suppression d'un mot (plugin mots)
  • l'autorisation de suppression d'un mots arborescents, ie pas d'enfant (plugin mots arborescents)
  • le type n'est pas encore affecté à un plugin
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_typeplugin_modifier_dist()

Autorisation de modifier un type de plugin.

autoriser_typeplugin_modifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Un type de plugin est un mot-cle technique pouvant être arborescent ou pas ce qui implique de vérifier :

  • l'autorisation minimale de typologie
  • l'autorisation de modification d'un mot (plugin mots)
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_typeplugin_creer_dist()

Autorisation de créer un type de plugin.

autoriser_typeplugin_creer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Un type de plugin est un mot-cle technique pouvant être arborescent ou pas ce qui implique de vérifier :

  • l'autorisation minimale de typologie
  • l'autorisation de création d'un mot (plugin mots)
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation. Contient le groupe de mots dans lequel créer le mot.

Return values
bool —

true s'il a le droit, false sinon

autoriser_plugin_affecter_dist()

Autorisation, pour un plugin, de lui affecter un type de plugin, de lui supprimer ou de lui modifier une affectation existante.

autoriser_plugin_affecter_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

L'autorisation est générique et ne dépend pas du plugin concerné :

  • l'autorisation minimale de typologie soit les administrateurs complets.
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation. Contient le groupe de mots dans lequel créer le mot.

Return values
bool —

true s'il a le droit, false sinon

autoriser_typologie_menu_dist()

Autorisation d'affichage du menu d'accès à gestion des typologies de plugin (page=svptype_typologie).

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

Il faut être autorisé à utiliser le plugin.

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

svptype_formulaire_fond()

Modifie les champs du formulaire d'édition (création ou modification) d'un mot.

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

Sur les mots appartenant à un groupe plugin :

  • ajouter la saisie de l'identifiant juste avant le titre
  • remplacer la saisie du parent par une saisie du type parent basée sur la saisie type_plugin.
  • remplacer la saisie du groupe par un hidden avec l'id du groupe qui ne peut pas être modifié.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

formulaire_fond

Return values
array<string|int, mixed> —

Données du pipeline complétées

svptype_formulaire_verifier()

Vérifie la saisie du formulaire d'édition d'un mot plugin.

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

Sur les mots appartenant à un groupe plugin :

  • l'identifiant doit être non vide et pas déjà utilisé
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

formulaire_verifier

Return values
array<string|int, mixed> —

Données du pipeline complétées

svptype_pre_insertion()

Insère des modifications juste avant la création d'un mot plugin (catégorie ou tag).

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

Lors de la création d'un mot plugin :

  • Ajoute l'identifiant du mot.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

pre_insertion

Return values
array<string|int, mixed> —

Données du pipeline complétées

svptype_pre_edition()

Insère des modifications lors de l'édition de mots.

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

Lors de l'édition d'un mot plugin (catégorie ou tag) :

  • Ajoute la modification de l'identifiant
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

pre_edition

Return values
array<string|int, mixed> —

Données du pipeline complétées

svptype_pre_boucle()

Exclure les groupes de mots et les mots-clés relatifs à une typologie de plugin si le critère typologie_plugin n'est pas explicitement utilisé.

svptype_pre_boucle(Boucle $boucle) : Boucle
Parameters
$boucle : Boucle

Description de la boucle.

Return values
Boucle —

Description complétée de la boucle.

svptype_afficher_contenu_objet()

Ajoute le champs identifiant dans l'affichage d'un mot plugin.

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

Données du pipeline

Tags
pipeline

afficher_contenu_objet

Return values
array<string|int, mixed> —

Données du pipeline complétées

svptype_affiche_milieu()

Utilisation du pipeline affiche milieu.

svptype_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Ajoute les formulaires d'édition des types de plugin pour chaque typologie supportée.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed> —

Données du pipeline mise à jour.

svptype_affiche_droite()

Insertion dans le pipeline affiche_gauche Affiche la liste des plugins appartenant à la même catégorie.

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

Flux d'entrée

Return values
array<string|int, mixed> —

Flux mis à jour

svptype_liste_ezcollection()

Déclare de nouvelles collections (les typologies, les affectations) et met à jour les collections existantes déjà déclarées par SVP API (plugins).

svptype_liste_ezcollection(array<string|int, mixed> $collections) : array<string|int, mixed>
Parameters
$collections : array<string|int, mixed>

Configuration des collections déjà déclarées.

Tags
pipeline

declarer_collections_svp

Return values
array<string|int, mixed> —

Collections complétées.

svptype_post_ezcollection()

Complète la collection après son calcul standard.

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

Pour la collection plugins :

  • Ajoute pour chaque élément les champs de typologie comme categorie et tag.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

post_collection_svp

Return values
array<string|int, mixed> —

Données du pipeline complétées

svptype_post_ezressource()

Complète la collection après son calcul standard.

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

Pour la collection plugins :

  • Ajoute pour chaque élément les champs de typologie comme categorie et tag.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

post_collection_svp

Return values
array<string|int, mixed> —

Données du pipeline complétées


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results