svptype.php
Ce fichier contient l'ensemble des fonctions de service spécifiques à une collection.
Table of Contents
Functions
- 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.
Functions
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(mixed $profondeur, array<string, mixed> &$erreur) : bool
Parameters
- $profondeur : mixed
-
La valeur du critère profondeur
- $erreur : array<string, mixed>
-
Tableau initialisé avec les index identifiant l'erreur.
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(mixed $typologie, array<string, mixed> &$erreur) : bool
Parameters
- $typologie : mixed
-
Identifiant de la typologie concernée : categorie, tag...
- $erreur : array<string, mixed>
-
Tableau initialisé avec les index identifiant l'erreur.
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(mixed $categorie, array<string, mixed> &$erreur) : bool
La fonction récupère via l'API du plugin la liste des catégories autorisées.
Parameters
- $categorie : mixed
-
La valeur du critère catégorie
- $erreur : array<string, mixed>
-
Tableau initialisé avec les index identifiant l'erreur.
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(mixed $categorie) : string
Parameters
- $categorie : mixed
-
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.