svptype_plugin.php
Ce fichier contient des compléments de l'API de gestion de l'objet plugin.
Table of Contents
Functions
- 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() : string
- Elabore la condition SQL pour lister les plugins ayant une affectation avec un type donné, un type quelconque ou n'étant pas du tout affecté.
Functions
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...).
Tags
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.
Tags
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()
Elabore la condition SQL pour lister les plugins ayant une affectation avec un type donné, un type quelconque ou n'étant pas du tout affecté.
plugin_elaborer_condition(string $typologie[, null|int $id_mot = 0 ][, null|array<string|int, mixed> $plugins_exclus = [] ]) : string
Parameters
- $typologie : string
-
Identifiant de la typologie
- $id_mot : null|int = 0
-
Id du mot représentant le type de plugin
- $plugins_exclus : null|array<string|int, mixed> = []
-
Liste des id de plugin exclus
Return values
string —Condition SQL