Documentation du code de SPIP et ses plugins

Motus

Documentation

Packages

SPIP

Table of Contents

motus_declarer_champs_extras()  : array<string|int, mixed>
Déclarer le champs extras
motus_groupes_mots_arborescents_heritages()  : Liste
Ajoute rubriques_on dans les champs hérités des groupes arborescents
motus_upgrade()  : void
Installation du plugin
motus_vider_tables()  : void
Désinstallation du plugin
motus_update_rubrique_on()  : mixed
Mise à jour du type du champ rubrique_on de varchar(255) à text
motus_autoriser()  : mixed
Fonction d'appel du pipeline
autoriser_spip_groupes_mots_voirextra_rubriques_on_dist()  : bool
Autorisation de voir le champs extra rubriques_on sur les groupes
autoriser_spip_groupes_mots_modifierextra_rubriques_on_dist()  : bool
Autorisation de voir le champs extra rubriques_on sur les groupes
autoriser_associermots()  : bool
Autorisation d'associer des mots à un objet
autoriser_groupemots_afficherselecteurmots()  : bool
Autorisation d'afficher le selecteur de mots
motus_autoriser_groupe_si_selection_rubrique()  : bool
Retourne vrai si une selection de rubrique s'applique à cet objet
autoriser_groupemots_dansrubrique_dist()  : bool
Retourne vrai si la rubrique $id fait partie d'une des branches de $opt['rubriques_on']

Functions

motus_declarer_champs_extras()

Déclarer le champs extras

motus_declarer_champs_extras([array<string|int, mixed> $champs = array() ]) : array<string|int, mixed>

Ajoute un champ «rubrique_on» sur les groupes de mots

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

Description des champs extras pour chaque table SQL

Tags
pipeline

declarer_champs_extras

Return values
array<string|int, mixed>

Description des champs extras complétée

motus_groupes_mots_arborescents_heritages()

Ajoute rubriques_on dans les champs hérités des groupes arborescents

motus_groupes_mots_arborescents_heritages(array<string|int, mixed> $champs) : Liste

Lorsque le plugin de groupes arborescents est présent, on fait hériter automatiquement les valeurs définies dans les restrictions de rubrique du groupe de mot racine.

L'autorisation du champs extras le cache dans les groupes enfants.

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

Liste des champs à hériter aux groupes enfants

Tags
pipeline

groupes_mots_arborescents_heritages

Return values
Liste

des champs complété de rubriques_on

motus_upgrade()

Installation du plugin

motus_upgrade(string $nom_meta_base_version, string $version_cible) : void
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)

Return values
void

motus_vider_tables()

Désinstallation du plugin

motus_vider_tables(string $nom_meta_base_version) : void
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

Return values
void

motus_update_rubrique_on()

Mise à jour du type du champ rubrique_on de varchar(255) à text

motus_update_rubrique_on() : mixed
Return values
mixed

motus_autoriser()

Fonction d'appel du pipeline

motus_autoriser() : mixed
Tags
pipeline

autoriser

Return values
mixed

autoriser_spip_groupes_mots_voirextra_rubriques_on_dist()

Autorisation de voir le champs extra rubriques_on sur les groupes

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

Il est hérité du parent. Toujours vrai

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

Autorisation de voir le champs extra rubriques_on sur les groupes

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

On le limite aux groupes racine (si plugin gma - groupes mots arborescents)

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

Autorisation d'associer des mots à un objet

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

Si l'affichage est autorisé par la fonction mère, On teste que les restrictions eventuelles sur le groupe ne viennent pas faire qu'il n'y aurait aucun groupe d'affiché ensuite

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

Autorisation d'afficher le selecteur de mots

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

Autorisation pour un groupe de mot donné, dans un objet / id_objet donne

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

motus_autoriser_groupe_si_selection_rubrique()

Retourne vrai si une selection de rubrique s'applique à cet objet

motus_autoriser_groupe_si_selection_rubrique(string $restrictions, string $objet, int $id_objet, int $qui) : bool

Autrement dit, si l'objet appartient à une des rubriques données

Parameters
$restrictions : string

Liste des restrictions issues d'une selection avec le selecteur generique (rubrique|3)

$objet : string

Objet sur lequel on teste l'appartenance a une des rubriques (article)

$id_objet : int

Identifiant de l'objet.

$qui : int

De qui teste t'on l'autorisation.

Return values
bool

autoriser_groupemots_dansrubrique_dist()

Retourne vrai si la rubrique $id fait partie d'une des branches de $opt['rubriques_on']

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

Autrement dit, si la rubrique appartient à une des rubriques données

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

Search results