SPIP Code

Documentation du code de SPIP et de ses plugins

Mots

Documentation

Table of Contents

Packages

Application
SPIP

Functions

action_editer_groupe_mots_dist()  : array<string|int, mixed>
Action d'édition d'un groupe de mots clés dans la base de données dont l'identifiant du groupe est donné en paramètre de cette fonction ou en argument de l'action sécurisée
groupe_mots_inserer()  : int|bool
Insertion d'un groupe de mots clés
groupe_mots_modifier()  : string|null
Modifier un groupe de mot
action_editer_mot_dist()  : array<string|int, mixed>
Action d'édition d'un mot clé dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée
mot_inserer()  : int|bool
Insertion d'un mot dans un groupe
mot_modifier()  : string|null
Modifier un mot
mot_instituer()  : null|string
Instituer un mot clé : modifier son groupe parent
mot_supprimer()  : mixed
Supprimer un mot
mot_associer()  : int|bool
Associer un mot à des objets listés sous forme `array($objet=>$id_objets,...)`
mot_dissocier()  : int|bool
Dissocier un mot des objets listés sous forme `array($objet=>$id_objets,...)`
mot_qualifier()  : int|bool
Qualifier le lien d'un mot avec les objets listés `array($objet=>$id_objets,...)`
un_seul_mot_dans_groupe()  : bool
Teste si un groupe ne doit avoir qu'un seul mot clé associé
action_supprimer_groupe_mots_dist()  : mixed
Action supprimant un groupe de mots clés dans la base de données dont l'identifiant du groupe est donné en paramètre de cette fonction ou en argument de l'action sécurisée
action_supprimer_mot_dist()  : mixed
Action supprimant un mot clé dans la base de données dont l'identifiant est en argument de l'action sécurisée
mots_declarer_tables_interfaces()  : array<string|int, mixed>
Déclarer les interfaces des tables mots et groupes de mots pour le compilateur
mots_declarer_tables_auxiliaires()  : array<string|int, mixed>
Déclarer les tables auxiliaires des mots
mots_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclarer les objets éditoriaux des mots et groupes de mots
formulaires_administrer_mot_charger_dist()  : mixed
afficher_options_mots()  : mixed
formulaires_administrer_mot_verifier_dist()  : mixed
admot_recupere_id_mot()  : mixed
admot_associer_objets_mot()  : mixed
admot_dissocier_objets_mot()  : mixed
formulaires_administrer_mot_traiter_dist()  : mixed
formulaires_configurer_mots_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de configuration des mots
formulaires_configurer_mots_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire de configuration des mots
formulaires_editer_groupe_mot_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'édition d'un groupe de mots
formulaires_editer_groupe_mot_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne representent pas l'objet édité
groupes_mots_edit_config()  : array<string|int, mixed>
Choix par défaut des options de présentation
formulaires_editer_groupe_mot_verifier_dist()  : array<string|int, mixed>
Vérification du formulaire d'édition d'un groupe de mots
formulaires_editer_groupe_mot_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'édition d'un groupe de mots
formulaires_editer_mot_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'édition d'un mot
formulaires_editer_mot_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne representent pas l'objet edité
mots_edit_config()  : array<string|int, mixed>
Choix par défaut des options de présentation
formulaires_editer_mot_verifier_dist()  : array<string|int, mixed>
Vérification du formulaire d'édition d'un mot
formulaires_editer_mot_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire d'édition d'un mot
filtre_objets_associes_mot_dist()  : array<string|int, string>
Compte le nombre d'objets associés pour chaque type d'objet, liés à un mot clé donné.
calculer_utilisations_mots()  : array<string|int, mixed>
Calculer les nombres d'éléments (articles, etc.) liés à chaque mot d'un groupe de mots
mots_upgrade()  : mixed
Installation/maj des tables mots et groupes de mots.
mots_vider_tables()  : mixed
Désinstallation/suppression des tables mots et groupes de mots
mots_autoriser()  : mixed
Fonction d'appel pour le pipeline
autoriser_mots_voir_dist()  : bool
Autorisation de voir la page mots
autoriser_mots_menu_dist()  : bool
Autorisation de voir un élément de menu
autoriser_motcreer_menu_dist()  : bool
Autorisation de voir le bouton d'accès rapide à la création d'un mot clé
autoriser_groupemots_voir_dist()  : bool
Autorisation de voir un groupe de mots
autoriser_groupemots_creer_dist()  : bool
Autorisation de créer un groupe de mots
autoriser_groupemots_modifier_dist()  : bool
Autorisation de modifier un groupe de mots
autoriser_groupemots_supprimer_dist()  : bool
Autorisation de supprimer un groupe de mots
autoriser_mot_modifier_dist()  : bool
Autorisation de modifier un mot
autoriser_mot_creer_dist()  : bool
Autorisation de créer un mot
autoriser_mot_supprimer_dist()  : bool
Autorisation de supprimer un mot
autoriser_associermots_dist()  : bool
Autorisation d'associer des mots à un objet
autoriser_groupemots_afficherselecteurmots_dist()  : bool
Autorisation d'affichier le sélecteur de mots
autoriser_mot_iconifier_dist()  : bool
Autorisation d'affichier le formulaire de logo
autoriser_groupemots_iconifier_dist()  : bool
Autorisation d'affichier le formulaire de logo
mots_ieconfig_metas()  : array<string|int, mixed>
Ajoute les metas sauvegardables de Mots pour le plugin IEConfig
mots_configurer_liste_metas()  : array<string|int, mixed>
Définir les meta de configuration liées aux mots
mots_affiche_milieu()  : array<string|int, mixed>
Utilisation du pipeline affiche milieu
mots_optimiser_base_disparus()  : array<string|int, mixed>
Optimise la base de données en supprimant les liens orphelins
mots_post_edition()  : array<string|int, mixed>
Copier le type des groupes sur la table spip_mots à chaque changement d'un groupe.
puce_statut_mot_dist()  : string
Afficher la puce statut d'un mot : en fait juste une icone indépendante du statut

Functions

action_editer_groupe_mots_dist()

Action d'édition d'un groupe de mots clés dans la base de données dont l'identifiant du groupe est donné en paramètre de cette fonction ou en argument de l'action sécurisée

action_editer_groupe_mots_dist([null|int $id_groupe = null ]) : array<string|int, mixed>

Si aucun identifiant n'est donné, on crée alors un nouveau groupe de mots clés.

Parameters
$id_groupe : null|int = null

Identifiant du groupe de mot-clé. En absence utilise l'argument de l'action sécurisée.

Return values
array<string|int, mixed> —

Liste (identifiant du groupe de mot clé, Texte d'erreur éventuel)

groupe_mots_inserer()

Insertion d'un groupe de mots clés

groupe_mots_inserer([int $id_parent = null ][, null|array<string|int, mixed> $set = null ]) : int|bool
Parameters
$id_parent : int = null

inutilise, pour consistance de l'API

$set : null|array<string|int, mixed> = null
Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
int|bool —

Identifiant du nouveau groupe de mots clés.

groupe_mots_modifier()

Modifier un groupe de mot

groupe_mots_modifier(int $id_groupe[, array<string|int, mixed>|null $set = null ]) : string|null
Parameters
$id_groupe : int

Identifiant du grope de mots clés à modifier

$set : array<string|int, mixed>|null = null

Couples (colonne => valeur) de données à modifier. En leur absence, on cherche les données dans les champs éditables qui ont été postés

Return values
string|null —

Chaîne vide si aucune erreur, Null si aucun champ à modifier, Chaîne contenant un texte d'erreur sinon.

action_editer_mot_dist()

Action d'édition d'un mot clé dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée

action_editer_mot_dist([null|int $arg = null ]) : array<string|int, mixed>

Si aucun identifiant n'est donné, on crée alors un nouveau mot clé.

Parameters
$arg : null|int = null

Identifiant du mot-clé. En absence utilise l'argument de l'action sécurisée.

Return values
array<string|int, mixed> —

Liste (identifiant du mot clé, Texte d'erreur éventuel)

mot_inserer()

Insertion d'un mot dans un groupe

mot_inserer(int $id_groupe[, array<string|int, mixed>|null $set = null ]) : int|bool
Parameters
$id_groupe : int

Identifiant du groupe de mot

$set : array<string|int, mixed>|null = null
Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
int|bool —

Identifiant du nouveau mot clé, false si erreur.

mot_modifier()

Modifier un mot

mot_modifier(int $id_mot[, array<string|int, mixed>|null $set = null ]) : string|null
Parameters
$id_mot : int

Identifiant du mot clé à modifier

$set : array<string|int, mixed>|null = null

Couples (colonne => valeur) de données à modifier. En leur absence, on cherche les données dans les champs éditables qui ont été postés (via _request())

Return values
string|null —
  • Chaîne vide si aucune erreur,
  • Null si aucun champ n'est à modifier,
  • Chaîne contenant un texte d'erreur sinon.

mot_instituer()

Instituer un mot clé : modifier son groupe parent

mot_instituer(int $id_mot, array<string|int, mixed> $c) : null|string
Parameters
$id_mot : int

Identifiant du mot clé

$c : array<string|int, mixed>

Couples (colonne => valeur) des données à instituer

Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
null|string —

Null si aucun champ à modifier, chaîne vide sinon.

mot_supprimer()

Supprimer un mot

mot_supprimer(int $id_mot) : mixed
Parameters
$id_mot : int

Identifiant du mot clé à supprimer

Tags
pipeline_appel

trig_supprimer_objets_lies

mot_associer()

Associer un mot à des objets listés sous forme `array($objet=>$id_objets,...)`

mot_associer(int $id_mot, array<string|int, mixed> $objets[, array<string|int, mixed> $qualif = null ]) : int|bool

$id_objets peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type

On peut passer optionnellement une qualification du (des) lien(s) qui sera alors appliquée dans la foulée. En cas de lot de liens, c'est la même qualification qui est appliquée à tous.

Parameters
$id_mot : int

Identifiant du mot à faire associer

$objets : array<string|int, mixed>

Description des associations à faire

$qualif : array<string|int, mixed> = null

Couples (colonne => valeur) de qualifications à faire appliquer

Tags
example 
mot_associer(3, array('auteur'=>2));
// Ne fonctionnera pas ici car pas de champ 'vu' sur spip_mots_liens :
mot_associer(3, array('auteur'=>2), array('vu'=>'oui));
Return values
int|bool —

Nombre de modifications, false si erreur

mot_dissocier()

Dissocier un mot des objets listés sous forme `array($objet=>$id_objets,...)`

mot_dissocier(int $id_mot, array<string|int, mixed> $objets) : int|bool

$id_objets peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type

un * pour $id_mot,$objet,$id_objet permet de traiter par lot

Parameters
$id_mot : int

Identifiant du mot à faire dissocier

$objets : array<string|int, mixed>

Description des dissociations à faire

Return values
int|bool —

Nombre de modifications, false si erreur

mot_qualifier()

Qualifier le lien d'un mot avec les objets listés `array($objet=>$id_objets,...)`

mot_qualifier(int $id_mot, array<string|int, mixed> $objets, array<string|int, mixed> $qualif) : int|bool

$id_objets peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type

Une * pour $id_auteur,$objet,$id_objet permet de traiter par lot

Parameters
$id_mot : int

Identifiant du mot à faire associer

$objets : array<string|int, mixed>

Description des associations à faire

$qualif : array<string|int, mixed>

Couples (colonne => valeur) de qualifications à faire appliquer

Tags
example 
$c = array('vu'=>'oui');
Return values
int|bool —

Nombre de modifications, false si erreur

un_seul_mot_dans_groupe()

Teste si un groupe ne doit avoir qu'un seul mot clé associé

un_seul_mot_dans_groupe(int $id_groupe) : bool

Renvoyer TRUE si le groupe de mot ne doit être associé qu'une fois aux objet (maximum un seul mot de ce groupe associé à chaque objet)

Parameters
$id_groupe : int

Identifiant du groupe de mot clé

Return values
bool —

true si un seul mot doit être lié avec ce groupe, false sinon.

action_supprimer_groupe_mots_dist()

Action supprimant un groupe de mots clés dans la base de données dont l'identifiant du groupe est donné en paramètre de cette fonction ou en argument de l'action sécurisée

action_supprimer_groupe_mots_dist([null|int $id_groupe = null ]) : mixed

Supprime le groupe uniquement si on en a l'autorisation. Cela implique qu'il n'y ait pas de mots clés dans le groupe.

Parameters
$id_groupe : null|int = null

Identifiant du groupe à supprimer. En absence utilise l'argument de l'action sécurisée.

action_supprimer_mot_dist()

Action supprimant un mot clé dans la base de données dont l'identifiant est en argument de l'action sécurisée

action_supprimer_mot_dist() : mixed

mots_declarer_tables_interfaces()

Déclarer les interfaces des tables mots et groupes de mots pour le compilateur

mots_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>

Déclarations d'interface pour le compilateur

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed> —

Déclarations d'interface pour le compilateur

mots_declarer_tables_auxiliaires()

Déclarer les tables auxiliaires des mots

mots_declarer_tables_auxiliaires(array<string|int, mixed> $tables_auxiliaires) : array<string|int, mixed>
Parameters
$tables_auxiliaires : array<string|int, mixed>

Description des tables

Tags
pipeline

declarer_tables_auxiliaires

Return values
array<string|int, mixed> —

Description complétée des tables

mots_declarer_tables_objets_sql()

Déclarer les objets éditoriaux des mots et groupes de mots

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

formulaires_administrer_mot_charger_dist()

formulaires_administrer_mot_charger_dist(mixed $id_mot) : mixed
Parameters
$id_mot : mixed

afficher_options_mots()

afficher_options_mots(mixed $id_selected) : mixed
Parameters
$id_selected : mixed

formulaires_administrer_mot_verifier_dist()

formulaires_administrer_mot_verifier_dist(mixed $id_mot) : mixed
Parameters
$id_mot : mixed

admot_recupere_id_mot()

admot_recupere_id_mot(mixed $name) : mixed
Parameters
$name : mixed

admot_associer_objets_mot()

admot_associer_objets_mot(mixed $id_mot, mixed $objet, mixed $ids) : mixed
Parameters
$id_mot : mixed
$objet : mixed
$ids : mixed

admot_dissocier_objets_mot()

admot_dissocier_objets_mot(mixed $id_mot, mixed $objet, mixed $ids) : mixed
Parameters
$id_mot : mixed
$objet : mixed
$ids : mixed

formulaires_administrer_mot_traiter_dist()

formulaires_administrer_mot_traiter_dist(mixed $id_mot) : mixed
Parameters
$id_mot : mixed

formulaires_configurer_mots_charger_dist()

Chargement du formulaire de configuration des mots

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

Environnement du formulaire

formulaires_configurer_mots_traiter_dist()

Traitement du formulaire de configuration des mots

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

Retours du traitement

formulaires_editer_groupe_mot_charger_dist()

Chargement du formulaire d'édition d'un groupe de mots

formulaires_editer_groupe_mot_charger_dist([int|string $id_groupe = 'new' ][, string $retour = '' ][, string $config_fonc = 'groupes_mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_groupe : int|string = 'new'

Identifiant du groupe de mots. 'new' pour un nouveau groupe.

$retour : string = ''

URL de redirection après le traitement

$config_fonc : string = 'groupes_mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du groupe de mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
array<string|int, mixed> —

Environnement du formulaire

formulaires_editer_groupe_mot_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne representent pas l'objet édité

formulaires_editer_groupe_mot_identifier_dist([int|string $id_groupe = 'new' ][, string $retour = '' ][, string $config_fonc = 'groupes_mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : string
Parameters
$id_groupe : int|string = 'new'

Identifiant du groupe de mots. 'new' pour un nouveau groupe.

$retour : string = ''

URL de redirection après le traitement

$config_fonc : string = 'groupes_mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du groupe de mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
string —

Hash du formulaire

groupes_mots_edit_config()

Choix par défaut des options de présentation

groupes_mots_edit_config(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed> 
Valeurs de la ligne SQL du groupe de mot, si connu

return array Configuration pour le formulaire

Return values
array<string|int, mixed>

formulaires_editer_groupe_mot_verifier_dist()

Vérification du formulaire d'édition d'un groupe de mots

formulaires_editer_groupe_mot_verifier_dist([int|string $id_groupe = 'new' ][, string $retour = '' ][, string $config_fonc = 'groupes_mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_groupe : int|string = 'new'

Identifiant du groupe de mots. 'new' pour un nouveau groupe.

$retour : string = ''

URL de redirection après le traitement

$config_fonc : string = 'groupes_mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du groupe de mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
array<string|int, mixed> —

Tableau des erreurs

formulaires_editer_groupe_mot_traiter_dist()

Traitement du formulaire d'édition d'un groupe de mots

formulaires_editer_groupe_mot_traiter_dist([int|string $id_groupe = 'new' ][, string $retour = '' ][, string $config_fonc = 'groupes_mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_groupe : int|string = 'new'

Identifiant du groupe de mots. 'new' pour un nouveau groupe.

$retour : string = ''

URL de redirection après le traitement

$config_fonc : string = 'groupes_mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du groupe de mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
array<string|int, mixed> —

Retour des traitements

formulaires_editer_mot_charger_dist()

Chargement du formulaire d'édition d'un mot

formulaires_editer_mot_charger_dist([int|string $id_mot = 'new' ][, int $id_groupe = 0 ][, string $retour = '' ][, string $associer_objet = '' ][, string $dummy1 = '' ][, string $dummy2 = '' ][, string $config_fonc = 'mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_mot : int|string = 'new'

Identifiant du mot. 'new' pour un nouveau mot.

$id_groupe : int = 0

Identifiant du groupe parent (si connu)

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$dummy1 : string = ''

?

$dummy2 : string = ''

?

$config_fonc : string = 'mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
see
formulaires_editer_objet_charger()
Return values
array<string|int, mixed> —

Environnement du formulaire

formulaires_editer_mot_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne representent pas l'objet edité

formulaires_editer_mot_identifier_dist([int|string $id_mot = 'new' ][, int $id_groupe = 0 ][, string $retour = '' ][, string $associer_objet = '' ][, string $dummy1 = '' ][, string $dummy2 = '' ][, string $config_fonc = 'mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : string
Parameters
$id_mot : int|string = 'new'

Identifiant du mot. 'new' pour un nouveau mot.

$id_groupe : int = 0

Identifiant du groupe parent (si connu)

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$dummy1 : string = ''

?

$dummy2 : string = ''

?

$config_fonc : string = 'mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
string —

Hash du formulaire

mots_edit_config()

Choix par défaut des options de présentation

mots_edit_config(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed> 
Valeurs de la ligne SQL d'un mot, si connu

return array Configuration pour le formulaire

Return values
array<string|int, mixed>

formulaires_editer_mot_verifier_dist()

Vérification du formulaire d'édition d'un mot

formulaires_editer_mot_verifier_dist([int|string $id_mot = 'new' ][, int $id_groupe = 0 ][, string $retour = '' ][, string $associer_objet = '' ][, string $dummy1 = '' ][, string $dummy2 = '' ][, string $config_fonc = 'mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_mot : int|string = 'new'

Identifiant du mot. 'new' pour un nouveau mot.

$id_groupe : int = 0

Identifiant du groupe parent (si connu)

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$dummy1 : string = ''

?

$dummy2 : string = ''

?

$config_fonc : string = 'mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
see
formulaires_editer_objet_verifier()
Return values
array<string|int, mixed> —

Tableau des erreurs

formulaires_editer_mot_traiter_dist()

Traitements du formulaire d'édition d'un mot

formulaires_editer_mot_traiter_dist([int|string $id_mot = 'new' ][, int $id_groupe = 0 ][, string $retour = '' ][, string $associer_objet = '' ][, string $dummy1 = '' ][, string $dummy2 = '' ][, string $config_fonc = 'mots_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_mot : int|string = 'new'

Identifiant du mot. 'new' pour un nouveau mot.

$id_groupe : int = 0

Identifiant du groupe parent (si connu)

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$dummy1 : string = ''

?

$dummy2 : string = ''

?

$config_fonc : string = 'mots_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL du mot, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
array<string|int, mixed> —

Retour des traitements

filtre_objets_associes_mot_dist()

Compte le nombre d'objets associés pour chaque type d'objet, liés à un mot clé donné.

filtre_objets_associes_mot_dist(int $id_mot, int $id_groupe) : array<string|int, string>
Parameters
$id_mot : int

Identifiant du mot clé

$id_groupe : int

Identifiant du groupe parent

Tags
pipeline_appel

afficher_nombre_objets_associes_a

Return values
array<string|int, string> —

Tableau de textes indiquant le nombre d'éléments tel que '3 articles'

calculer_utilisations_mots()

Calculer les nombres d'éléments (articles, etc.) liés à chaque mot d'un groupe de mots

calculer_utilisations_mots(int $id_groupe) : array<string|int, mixed>
Parameters
$id_groupe : int

Identifiant du groupe de mots

Return values
array<string|int, mixed> —

Couples (tables de liaison => mots). Mots est un tableau de couples (id_mot => nombre d'utilisation)

mots_upgrade()

Installation/maj des tables mots et groupes de mots.

mots_upgrade(string $nom_meta_base_version, string $version_cible) : mixed

..

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

mots_vider_tables()

Désinstallation/suppression des tables mots et groupes de mots

mots_vider_tables(string $nom_meta_base_version) : mixed
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

mots_autoriser()

Fonction d'appel pour le pipeline

mots_autoriser() : mixed
Tags
pipeline

autoriser

autoriser_mots_voir_dist()

Autorisation de voir la page mots

autoriser_mots_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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_mots_menu_dist()

Autorisation de voir un élément de menu

autoriser_mots_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

Tags
uses
autoriser_mots_voir_dist()
Return values
bool —

true s'il a le droit, false sinon

autoriser_motcreer_menu_dist()

Autorisation de voir le bouton d'accès rapide à la création d'un mot clé

autoriser_motcreer_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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_groupemots_voir_dist()

Autorisation de voir un groupe de mots

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

L'autorisation est donnée selon la configuration du groupe qui gère cela par type d'auteur (administrateur, rédacteurs, visiteurs)

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

Autorisation de créer un groupe de mots

autoriser_groupemots_creer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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_groupemots_modifier_dist()

Autorisation de modifier un groupe de mots

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

Cela inclut également l'ajout ou modification des mots lui appartenant

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

Autorisation de supprimer un groupe de mots

autoriser_groupemots_supprimer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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_mot_modifier_dist()

Autorisation de modifier un mot

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

Il faut avoir le droit de modifier le groupe parent

Note : passer l'id_groupe dans le tableau d'option permet de gagner du CPU et une requête SQL (c'est ce que fait l'espace privé)

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

Autorisation de créer un mot

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

Vérifie si une association est demandée en option, qu'elle est possible dans un des groupes, c'est à dire qu'une liaison est possible entre un groupe et l'objet lié

Si l'id_groupe est passé en option, vérifie également que l'auteur a le droit de modifier ce groupe

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

Autorisation de supprimer un mot

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

Par défaut : pouvoir créer un mot dans le groupe

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

Autorisation d'associer des mots à un objet

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

Si groupe_champ ou id_groupe est fourni dans le tableau d'options, on regarde les droits pour ce groupe en particulier

On interdit aussi d'associer des mots à d'autres mots ou groupes de 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_groupemots_afficherselecteurmots_dist()

Autorisation d'affichier le sélecteur de mots

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

Vérifie le droit d'afficher le selecteur de mots pour un groupe de mot donné, dans un objet / id_objet donné

C'est fonction de la configuration du groupe de 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_mot_iconifier_dist()

Autorisation d'affichier le formulaire de logo

autoriser_mot_iconifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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_groupemots_iconifier_dist()

Autorisation d'affichier le formulaire de logo

autoriser_groupemots_iconifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

mots_ieconfig_metas()

Ajoute les metas sauvegardables de Mots pour le plugin IEConfig

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

Déclaration des sauvegardes

Tags
pipeline

ieconfig_metas

Return values
array<string|int, mixed> —

Déclaration des sauvegardes complétées

mots_configurer_liste_metas()

Définir les meta de configuration liées aux mots

mots_configurer_liste_metas(array<string|int, mixed> $metas) : array<string|int, mixed>
Parameters
$metas : array<string|int, mixed>

Couples nom de la méta => valeur par défaut

Tags
pipeline

configurer_liste_metas

Return values
array<string|int, mixed> —

Couples nom de la méta => valeur par défaut

mots_affiche_milieu()

Utilisation du pipeline affiche milieu

mots_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Ajoute le formulaire de configuration des mots sur la configuration des contenus
  • Ajoute le formulaire d'édition de mots sur les objets qui le peuvent
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed> —

Données du pipeline

mots_optimiser_base_disparus()

Optimise la base de données en supprimant les liens orphelins

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

Données du pipeline

Tags
pipeline

optimiser_base_disparus

Return values
array<string|int, mixed> —

Données du pipeline

mots_post_edition()

Copier le type des groupes sur la table spip_mots à chaque changement d'un groupe.

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

Données du pipeline

Tags
pipeline

post_edition

Return values
array<string|int, mixed> —

Données du pipeline

puce_statut_mot_dist()

Afficher la puce statut d'un mot : en fait juste une icone indépendante du statut

puce_statut_mot_dist(int $id, string $statut, int $id_groupe, string $type[, string $ajax = '' ][, bool $menu_rapide = _ACTIVER_PUCE_RAPIDE ]) : string
Parameters
$id : int

Identifiant du mot clé

$statut : string

Statut du mot (il n'en a pas)

$id_groupe : int

Identifiant du groupe de mot clé parent

$type : string

Type d'objet

$ajax : string = ''

Indique s'il ne faut renvoyer que le coeur du menu car on est dans une requete ajax suite à un post de changement rapide

$menu_rapide : bool = _ACTIVER_PUCE_RAPIDE

Indique si l'on peut changer le statut, ou si on l'affiche simplement

Return values
string —

Code HTML de l'image de puce de statut à insérer

Search results