filtres_selecteur_generique.php
Filtres pour les sélecteurs d'objets
Table of Contents
Functions
- selecteur_lister_objets() : array<string|int, mixed>
- Fournit la liste des objets ayant un sélecteur
- picker_selected() : array<string|int, mixed>
- Extrait des informations d'un tableau d'entrées `array("rubrique|9", "article|8", ...)` ou une chaine brute `rubrique|9,article|8,...`
- picker_identifie_id_rapide() : mixed
- Récupère des informations sur un objet pour pouvoir l'ajouter aux éléments sélectionnés
- test_enfants_rubrique() : string
- Déterminer si une rubrique a des enfants à afficher ou non
Functions
selecteur_lister_objets()
Fournit la liste des objets ayant un sélecteur
selecteur_lister_objets([array<string|int, mixed> $includelist = [] ][, array<string|int, mixed> $excludelist = [] ]) : array<string|int, mixed>
Concrètement, va chercher tous les formulaires/selecteur/hierarchie-{trucs}.html
Ensuite on ajoute les parents obligatoires éventuels
Parameters
- $includelist : array<string|int, mixed> = []
-
Liste d’inclusion décrivant les objets à lister
- $excludelist : array<string|int, mixed> = []
-
Liste d’exclusion décrivant les objets à ne pas lister
Tags
Return values
array<string|int, mixed> —Retourne un tableau de deux entrées listant les objets à lister et les objets sélectionnables
- selectionner : tableau des objets que l'on pourra sélectionner (avec un +)
- afficher : tableau des objets à afficher (mais pas forcément sélectionnables)
picker_selected()
Extrait des informations d'un tableau d'entrées `array("rubrique|9", "article|8", ...)` ou une chaine brute `rubrique|9,article|8,...`
picker_selected(array<string|int, mixed>|string $selected[, string $type = '' ]) : array<string|int, mixed>
Peut retourner un tableau de couples (objet => id_objet) ou la liste
des identifiants d'un objet précis si $type est fourni.
Parameters
- $selected : array<string|int, mixed>|string
-
Liste des entrées : tableau ou chaine séparée par des virgules
- $type : string = ''
-
Type de valeur à recuperer tel que
rubrique,article
Tags
Return values
array<string|int, mixed> —liste des couples (objets => id_objet) ou liste des identifiants d'un type d'objet.
picker_identifie_id_rapide()
Récupère des informations sur un objet pour pouvoir l'ajouter aux éléments sélectionnés
picker_identifie_id_rapide(string|int $ref[, array<string|int, mixed>|bool $rubriques_ou_objets = false ][, bool $articles = false ]) : mixed
Parameters
- $ref : string|int
-
Référence de l'objet à chercher sous forme raccourcie rub123 art123 ou meme 123 si pas d'ambiguité ou si un article
- $rubriques_ou_objets : array<string|int, mixed>|bool = false
-
Soit un booléen (pouvant être une chaîne vide aussi) indiquant que les rubriques sont sélectionnables soit un tableau complet des objets sélectionnables.
- $articles : bool = false
-
Booléen indiquant si les articles sont sélectionnables
Tags
test_enfants_rubrique()
Déterminer si une rubrique a des enfants à afficher ou non
test_enfants_rubrique(int $id_rubrique[, array<string|int, mixed> $types = [] ]) : string
On test d'abord si la rubrique a des sous rubriques, et sinon on regarde les autres types sélectionnables, puis on regarde si la rubrique contient certains de ces objets
Parameters
- $id_rubrique : int
-
Identifiant de la rubrique
- $types : array<string|int, mixed> = []
-
Liste de type d'objets. Si l'un de ces objet est présent dans la rubrique, alors cette rubrique est à afficher
Tags
Return values
string —Comme le filtre oui : espace ( ) si rubrique à afficher, chaîne vide sinon.