Documentation du code de SPIP et de ses plugins

SVP Typologie

Documentation

Packages

Application
SPIP

Table of Contents

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.
action_telecharger_export_dist()  : void
Telecharger un fichier d'export JSON.
svptype_declarer_tables_objets_sql()  : array<string|int, mixed>
Ajouter le champ `identifiant` à la table des mots.
svptype_declarer_tables_auxiliaires()  : mixed
svptype_declarer_tables_interfaces()  : mixed
categories_collectionner()  : array<string|int, mixed>
Récupère la liste des catégories de la table spip_mots éventuellement filtrée par profondeur.
categories_verifier_filtre_profondeur()  : bool
Détermine si la valeur de la profondeur est valide.
tags_collectionner()  : array<string|int, mixed>
Récupère la liste des tags de la table spip_mots.
affectations_collectionner()  : array<string|int, mixed>
Récupère la liste des affectations pour une typologie donnée.
affectations_verifier_filtre_typologie()  : bool
Détermine si la valeur de la profondeur est valide.
plugins_verifier_filtre_categorie()  : bool
Détermine si la valeur de la catégorie est valide.
plugins_conditionner_categorie()  : string
Construit le critère applicable sur la table spip_plugins pour filtrer la collection sur le critère categorie.
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>
Traiter le post des informations d'édition de liens.
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).
mot_est_racine()  : bool
Vérifie que le mot identifié par son id est un mot racine d'une typologie arborescente.
groupe_est_typologie_plugin()  : bool
Vérifie que le groupe identifié par son id matérialise bien une typologie de plugin.
mot_lire_groupe()  : int
Renvoie l'id du groupe d'un mot-clé.
mot_lire_identifiant()  : string
Renvoie le champ `identifiant` d'un mot-clé si celui-ci est un type de plugin.
mot_lire_enfants()  : array<string|int, mixed>
Renvoie les id des enfants d'un mot-clé.
plugin_affecter_type_plugin()  : bool
Affecte, pour un plugin donné, un nouveau type de plugin.
plugin_desaffecter_type_plugin()  : bool
Supprime, pour un plugin donné, une affectation d'un type de plugin.
plugin_lister_type_plugin()  : array<string|int, mixed>
Liste, pour un plugin donné, les types de plugin qui lui sont affectés pour une typologie donnée.
plugin_elaborer_condition()  : mixed
type_plugin_lire()  : array<string|int, mixed>|string
Retourne la description complète du type de plugin ou uniquement une information précise.
type_plugin_repertorier()  : array<string|int, mixed>
Renvoie l'information brute demandée pour l'ensemble des types de plugins d'une typologie donnée ou toute les descriptions si aucune information n'est explicitement demandée.
type_plugin_repertorier_affectation()  : array<string|int, mixed>
Renvoie les affectations (type de plugin, plugin) pour une typologie donnée.
type_plugin_repertorier_enfant()  : array<string|int, mixed>
Liste les types de plugin enfants d'un type d'une typologie donnée.
type_plugin_compter_enfant()  : int
Dénombre les types de plugin enfants d'un type d'une typologie donnée.
type_plugin_compter_affectation()  : int
Dénombre les affectations (type de plugin, plugin) d'un type d'une typologie.
type_plugin_elaborer_condition()  : mixed
typologie_plugin_configurer()  : array<string|int, mixed>
Initialise la configuration des différentes typologies de plugin proposées.
typologie_plugin_creer_groupe()  : void
Création des groupes de mots matérialisant chaque typologie de plugin.
typologie_plugin_vider()  : bool
Supprime, pour une typologie donnée, l'ensemble des types de plugin ou l'ensemble des affectations plugin-type de plugin.
typologie_plugin_importer()  : bool|int
Importe une liste de types de plugin appartenant à une même typologie.
typologie_plugin_exporter()  : bool|string
Exporte de la base de données les types de plugin appartenant à une même typologie dans un fichier sur le serveur.
typologie_plugin_importer_affectation()  : int
Importe une liste d'affectations (type de plugin, plugin) pour une typologie donnée.
typologie_plugin_exporter_affectation()  : bool|string
Exporte les affectations (type de plugin, plugin) appartenant à la même typologie dans un fichier sur le serveur.
typologie_plugin_export_lister()  : array<string|int, mixed>
Lister les fichiers d'export JSON stockés dans le répertoire temporaire idoine.
typologie_plugin_collectionner()  : array<string|int, mixed>
Elabore la collection des types de plugin pour la typologie concernée au format demandé par l'API REST Factory.
typologie_plugin_calculer_critere()  : string
Construit la condition SQL issue de l'analyse du critère `{typologie_plugin[ identifiant1, identifiant2]}`.
selection_type_plugin_peupler()  : mixed
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).
critere_typologie_plugin_dist()  : void
Critère de restriction d'une boucle mots ou groupes de mots à une ou plusieurs typologies de plugin.
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()  : object
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_desaffecter_plugin_dist()

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

action_desaffecter_plugin_dist([mixed $arguments = null ]) : void

L'argument attendu est prefixe:id_mot.

Parameters
$arguments : mixed = null
Tags
uses
plugin_desaffecter_type_plugin()
Return values
void

action_supprimer_export_dist()

Supprimer un fichier d'export JSON.

action_supprimer_export_dist() : void
Return values
void

action_telecharger_export_dist()

Telecharger un fichier d'export JSON.

action_telecharger_export_dist() : void
Return values
void

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

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed>

Description complétée des tables

svptype_declarer_tables_auxiliaires()

svptype_declarer_tables_auxiliaires(mixed $tables_auxiliaires) : mixed
Parameters
$tables_auxiliaires : mixed
Return values
mixed

svptype_declarer_tables_interfaces()

svptype_declarer_tables_interfaces(mixed $interface) : mixed
Parameters
$interface : mixed
Return values
mixed

categories_collectionner()

Récupère la liste des catégories de la table spip_mots éventuellement filtrée par profondeur.

categories_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Tableau des conditions SQL à appliquer au select et correspondant aux filtres passés dans la requête.

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels.

$configuration : array<string|int, mixed>

Configuration de la collection catégories utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des catégories.

categories_verifier_filtre_profondeur()

Détermine si la valeur de la profondeur est valide.

categories_verifier_filtre_profondeur(string $profondeur, mixed &$erreur) : bool
Parameters
$profondeur : string

La valeur du critère profondeur

$erreur : mixed
Return values
bool

true si la valeur est valide, false sinon.

tags_collectionner()

Récupère la liste des tags de la table spip_mots.

tags_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Tableau des conditions SQL à appliquer au select et correspondant aux filtres passés dans la requête.

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels: toujours vide pour les tags.

$configuration : array<string|int, mixed>

Configuration de la collection catégories utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des catégories.

affectations_collectionner()

Récupère la liste des affectations pour une typologie donnée.

affectations_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Tableau des conditions SQL à appliquer au select et correspondant aux filtres passés dans la requête.

$filtres : array<string|int, mixed>

Tableau des critères : permet en particulier de choisir les affectations pour une typologie donnée.

$configuration : array<string|int, mixed>

Configuration de la collection affectations utile pour savoir quelle fonction appeler pour construire chaque filtre (pas utilisée aujourd'hui).

Return values
array<string|int, mixed>

Tableau des affectations indexé par préfixe de plugin.

affectations_verifier_filtre_typologie()

Détermine si la valeur de la profondeur est valide.

affectations_verifier_filtre_typologie(string $typologie, mixed &$erreur) : bool
Parameters
$typologie : string

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

$erreur : mixed
Return values
bool

true si la valeur est valide, false sinon.

plugins_verifier_filtre_categorie()

Détermine si la valeur de la catégorie est valide.

plugins_verifier_filtre_categorie(string $categorie, mixed &$erreur) : bool

La fonction récupère via l'API du plugin la liste des catégories autorisées.

Parameters
$categorie : string

La valeur du critère catégorie

$erreur : mixed
Return values
bool

true si la valeur est valide, false sinon.

plugins_conditionner_categorie()

Construit le critère applicable sur la table spip_plugins pour filtrer la collection sur le critère categorie.

plugins_conditionner_categorie(string $categorie) : string
Parameters
$categorie : string

La valeur du critère catégorie

Return values
string

Chaine représentant le critère sur la catégorie appliqué à la table spip_plugins.

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[, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
$id_plugin : int
$typologie : string
$options : array<string|int, mixed> = array()
Return values
array<string|int, mixed>

formulaires_editer_affectations_traiter()

Traiter le post des informations d'édition de liens.

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

Les formulaires peuvent poster dans quatre variables

  • ajouter_lien et supprimer_lien

Les deux premières peuvent être de trois formes différentes : ajouter_lien[]="objet1-id1-objet2-id2" ajouter_lien[objet1-id1-objet2-id2]="nimportequoi" ajouter_lien['clenonnumerique']="objet1-id1-objet2-id2" Dans ce dernier cas, la valeur ne sera prise en compte que si _request('clenonnumerique') est vrai (submit associé a l'input)

Parameters
$id_plugin : int
$typologie : string
$options : array<string|int, mixed> = array()
Return values
array<string|int, mixed>

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.

mot_est_racine()

Vérifie que le mot identifié par son id est un mot racine d'une typologie arborescente.

mot_est_racine(int $id_mot) : bool
Parameters
$id_mot : int

Id du mot-clé.

Return values
bool

True si le mot est une racine d'une typologie arborescente, false sinon.

groupe_est_typologie_plugin()

Vérifie que le groupe identifié par son id matérialise bien une typologie de plugin.

groupe_est_typologie_plugin(int $id_groupe) : bool
Parameters
$id_groupe : int

Id du groupe de mots concerné.

Return values
bool

True si le groupe est celui d'une typologie, false sinon.

mot_lire_groupe()

Renvoie l'id du groupe d'un mot-clé.

mot_lire_groupe(int $id_mot) : int
Parameters
$id_mot : int

Id du mot-clé.

Return values
int

Id du groupe d'appartenance du mot-clé ou 0 sinon.

mot_lire_identifiant()

Renvoie le champ `identifiant` d'un mot-clé si celui-ci est un type de plugin.

mot_lire_identifiant(int $id_mot) : string

Si le mot-clé n'est pas un type de plugin l'identifiant est vide.

Parameters
$id_mot : int

Id du mot-clé.

Return values
string

Champ identifiant du mot-clé si celui-ci est un type de plugin ou chaine vide sinon.

mot_lire_enfants()

Renvoie les id des enfants d'un mot-clé.

mot_lire_enfants(int $id_mot) : array<string|int, mixed>
Parameters
$id_mot : int

Id du mot-clé.

Return values
array<string|int, mixed>

Tableau des id des enfants d'un mot-clé ou tableau vide sinon.

plugin_affecter_type_plugin()

Affecte, pour un plugin donné, un nouveau type de plugin.

plugin_affecter_type_plugin(int|string $plugin, int $id_mot, string $typologie) : bool
Parameters
$plugin : int|string

La valeur du préfixe ou de l'id du plugin.

$id_mot : int

Id du mot matérialisant le type de plugin à désaffecter.

$typologie : string

Typologie à laquelle appartient le type de plugin (categorie, tag...).

Return values
bool

true si l'insertion se passe correctement ou false sinon.

plugin_desaffecter_type_plugin()

Supprime, pour un plugin donné, une affectation d'un type de plugin.

plugin_desaffecter_type_plugin(int|string $plugin, int $id_mot) : bool
Parameters
$plugin : int|string

La valeur du préfixe ou de l'id du plugin.

$id_mot : int

Id du mot matérialisant le type de plugin à désaffecter.

Return values
bool

true si la suppresion se passe correctement ou false sinon.

plugin_lister_type_plugin()

Liste, pour un plugin donné, les types de plugin qui lui sont affectés pour une typologie donnée.

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

La valeur du préfixe ou de l'id du plugin.

$typologie : string

Typologie à laquelle appartient le type de plugin (categorie, tag...).

Return values
array<string|int, mixed>

Liste des types de plugin d'une typologie (id du mot représentant le type) affectés au plugin concerné. Vide si aucune affectation.

plugin_elaborer_condition()

plugin_elaborer_condition(mixed $typologie, mixed $id_mot[, mixed $plugins_exclus = [] ]) : mixed
Parameters
$typologie : mixed
$id_mot : mixed
$plugins_exclus : mixed = []
Return values
mixed

type_plugin_lire()

Retourne la description complète du type de plugin ou uniquement une information précise.

type_plugin_lire(string $typologie, int|string $type_plugin[, array<string|int, mixed>|string $informations = array() ]) : array<string|int, mixed>|string
Parameters
$typologie : string

Typologie concernée : categorie, tag... Ne sert que si le type est passé sous forme du champ identifiant qui n'est unique qu'au sein d'une même typologie.

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

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

Identifiant d'un champ ou de plusieurs champs de la description d'un type de plugin. Si l'argument est vide, la fonction renvoie la description complète.

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

La description brute complète ou partielle du type de plugin :

  • sous la forme d'une valeur simple si l'information demandée est unique (chaine)
  • sous la forme d'un tableau associatif indexé par le nom du champ sinon.

type_plugin_repertorier()

Renvoie l'information brute demandée pour l'ensemble des types de plugins d'une typologie donnée ou toute les descriptions si aucune information n'est explicitement demandée.

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

Typologie concernée : categorie, tag...

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

Liste des couples (champ, valeur) ou tableau vide.

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

Identifiant d'un champ ou de plusieurs champs de la description d'un type de plugin. Si l'argument est vide, la fonction renvoie les descriptions complètes.

Return values
array<string|int, mixed>

Description complète ou information précise pour chaque type de plugin de la typologie concernée.

type_plugin_repertorier_affectation()

Renvoie les affectations (type de plugin, plugin) pour une typologie donnée.

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

Typologie concernée : categorie, tag...

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

Liste des couples (champ, valeur) ou tableau vide. Pratiquement, les critères admis sont prefixe, id_mot et aussi type qui revient à filtrer sur un type de plugin comme id_mot. Il est possible aussi d'utiliser type_racine qui indique qu'on cherche toutes les affectations des types enfants du type racine.

Return values
array<string|int, mixed>

Description de chaque affectation (type de plugin, plugin) de la typologie concernée.

type_plugin_repertorier_enfant()

Liste les types de plugin enfants d'un type d'une typologie donnée.

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

Typologie concernée : categorie, tag...

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

Return values
array<string|int, mixed>

Liste des enfants d'un type de plugin ou tableau vide si aucun.

type_plugin_compter_enfant()

Dénombre les types de plugin enfants d'un type d'une typologie donnée.

type_plugin_compter_enfant(string $typologie, int|string $type_plugin) : int
Parameters
$typologie : string

Typologie concernée : categorie, tag...

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

Return values
int

Nombre d'enfants d'un type de plugin ou 0 si aucun.

type_plugin_compter_affectation()

Dénombre les affectations (type de plugin, plugin) d'un type d'une typologie.

type_plugin_compter_affectation(string $typologie, int|string $type_plugin) : int
Parameters
$typologie : string

Typologie concernée : categorie, tag...

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

Return values
int

Nombre d'affectations (type de plugin, plugin) d'un type de plugin ou 0 si aucun.

type_plugin_elaborer_condition()

type_plugin_elaborer_condition(mixed $typologie, mixed $type_plugin, mixed $vue) : mixed
Parameters
$typologie : mixed
$type_plugin : mixed
$vue : mixed
Return values
mixed

typologie_plugin_configurer()

Initialise la configuration des différentes typologies de plugin proposées.

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

Cette configuration sert à initialiser l'index typologies de la meta svptype.

Return values
array<string|int, mixed>

Le tableau de la configuration par défaut indexé par l'identifiant de chaque typologie.

typologie_plugin_creer_groupe()

Création des groupes de mots matérialisant chaque typologie de plugin.

typologie_plugin_creer_groupe() : void

Si le groupe existe déjà on ne fait rien, sinon on le crée en stockant l'id du groupe obtenu dans la configuration idoine.

Return values
void

typologie_plugin_vider()

Supprime, pour une typologie donnée, l'ensemble des types de plugin ou l'ensemble des affectations plugin-type de plugin.

typologie_plugin_vider(string $typologie[, string $vue = 'liste' ]) : bool
Parameters
$typologie : string

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

$vue : string = 'liste'

Nature des données à supprimer. Prend les valeurs :

  • liste : pour les types de plugin,
  • affectation : pour les affectations plugin-type de plugin.
Return values
bool

True si le vidage s'est bien passé, false sinon.

typologie_plugin_importer()

Importe une liste de types de plugin appartenant à une même typologie.

typologie_plugin_importer(string $typologie, array<string|int, mixed> $types) : bool|int

Les types de plugin de la liste déjà présents en base de données sont ignorés.

Parameters
$typologie : string

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

$types : array<string|int, mixed>

Tableau des types présenté comme une arborescence ou à plat suivant la typologie.

Return values
bool|int

Nombre de catégories ajoutées.

typologie_plugin_exporter()

Exporte de la base de données les types de plugin appartenant à une même typologie dans un fichier sur le serveur.

typologie_plugin_exporter(string $typologie) : bool|string
Parameters
$typologie : string

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

Return values
bool|string

Le nom du fichier d'export ou false si erreur.

typologie_plugin_importer_affectation()

Importe une liste d'affectations (type de plugin, plugin) pour une typologie donnée.

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

Les affectations de la liste déjà présentes en base de données sont ignorées.

Parameters
$typologie : string

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

$affectations : array<string|int, mixed>

Tableau des affectations (type de plugin, plugin).

Return values
int

Nombre d'affectations ajoutées.

typologie_plugin_exporter_affectation()

Exporte les affectations (type de plugin, plugin) appartenant à la même typologie dans un fichier sur le serveur.

typologie_plugin_exporter_affectation(string $typologie) : bool|string
Parameters
$typologie : string

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

Return values
bool|string

Le nom du fichier d'export ou false si erreur.

typologie_plugin_export_lister()

Lister les fichiers d'export JSON stockés dans le répertoire temporaire idoine.

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

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

Return values
array<string|int, mixed>

Tableau associatif des fichiers d'export fournissant, le chemin complet, le nom sans extension, la date et la taille de chaque fichier.

typologie_plugin_collectionner()

Elabore la collection des types de plugin pour la typologie concernée au format demandé par l'API REST Factory.

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

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

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels.

Return values
array<string|int, mixed>

Tableau des types des plugins demandés.

typologie_plugin_calculer_critere()

Construit la condition SQL issue de l'analyse du critère `{typologie_plugin[ identifiant1, identifiant2]}`.

typologie_plugin_calculer_critere(array<string|int, mixed> $typologies, string $table) : string
Parameters
$typologies : array<string|int, mixed>

Liste des identifiants de typologie passé en argument du critère. Si la liste est vide on intègre toutes les typologies dans la condition.

$table : string

Identifiant de la table sur laquelle porte la condition, soit mots ou groupes_mots.

Return values
string

Condition SQL traduisant le critère (égalité ou IN).

selection_type_plugin_peupler()

selection_type_plugin_peupler(mixed $typologie[, mixed $options = array() ]) : mixed
Parameters
$typologie : mixed
$options : mixed = array()
Return values
mixed

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

Return values
void

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

Return values
void

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

critere_typologie_plugin_dist()

Critère de restriction d'une boucle mots ou groupes de mots à une ou plusieurs typologies de plugin.

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

Ce critère ne supporte pas la négation.

Fonctionne sur les tables spip_mots et spip_groupes_mots.

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
typologie_plugin_calculer_critere()
critere
example

{typologie_plugin}, pour intégrer toutes les typologies supportées dans la boucle {typologie_plugin categorie} {typologie_plugin categorie,tag} {typologie_plugin #ENV{typologie}}, #ENV{typologie} désigne forcément une unique typologie {typologie_plugin #GET{typologie}}, #GET{typologie} désigne forcément une unique typologie

Return values
void

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

Description de la boucle.

Return values
object

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

Search results