saisies_lister_disponibles.php
Gestion de listes des saisies disponibles (via .yaml)
Table of Contents
Functions
- saisies_lister_disponibles() : array<string|int, mixed>
- Liste toutes les saisies configurables (ayant une description).
- saisies_groupes_lister_disponibles() : array<string|int, mixed>
- Liste tous les groupes de saisies configurables (ayant une description).
- saisies_lister_disponibles_sql() : array<string|int, mixed>
- Lister les saisies existantes ayant une définition SQL.
- saisies_charger_infos() : array<string|int, mixed>
- Charger les informations contenues dans le YAML d'une saisie.
- saisies_recuperer_heritage() : array<string|int, mixed>
- Permet à une saisie d'hériter des options et valeur par défaut d'une autre saisies
- saisies_lister_categories() : array<string|int, mixed>
- Lister les catégories par défaut, puis les envoyer au pipeline
- saisies_lister_disponibles_par_categories() : array<string|int, mixed>
- Lister les saisies disponibles en les regroupant en catégories
- saisies_lister_disponibles_sql_par_categories() : mixed
- Liste par catégorie les saisies disponibles ayant une définition SQL
- saisies_regrouper_disponibles_par_categories() : array<string|int, mixed>
- Regroupe par categories les saisies
- saisies_lister_disponibles_par_categories_usort() : int
- Function de comparaison pour trier les saisies disponibles par rang Si pas de rang défini, on met après ceux avec rang Si deux saisies avec le même rang, on se rabat sur l'ordre alpha
Functions
saisies_lister_disponibles()
Liste toutes les saisies configurables (ayant une description).
saisies_lister_disponibles([string $saisies_repertoire = 'saisies' ][, bool $inclure_obsoletes = true ]) : array<string|int, mixed>
Parameters
- $saisies_repertoire : string = 'saisies'
-
le répertoire où trouver les saisies
- $inclure_obsoletes : bool = true
-
: faut-il inclure les saisies obsolètes ?
Return values
array<string|int, mixed> —Un tableau listant des saisies et leurs options
saisies_groupes_lister_disponibles()
Liste tous les groupes de saisies configurables (ayant une description).
saisies_groupes_lister_disponibles([mixed $saisies_repertoire = 'saisies' ]) : array<string|int, mixed>
Parameters
- $saisies_repertoire : mixed = 'saisies'
Return values
array<string|int, mixed> —Un tableau listant des saisies et leurs options
saisies_lister_disponibles_sql()
Lister les saisies existantes ayant une définition SQL.
saisies_lister_disponibles_sql([string $saisies_repertoire = 'saisies' ][, bool $inclure_obsoletes = true ]) : array<string|int, mixed>
Parameters
- $saisies_repertoire : string = 'saisies'
-
le répertoire où trouver les saisies
- $inclure_obsoletes : bool = true
-
: faut-il inclure les saisies obsolètes ?
Return values
array<string|int, mixed> —Un tableau listant des saisies et leurs options
saisies_charger_infos()
Charger les informations contenues dans le YAML d'une saisie.
saisies_charger_infos(string $type_saisie[, mixed $saisies_repertoire = 'saisies' ]) : array<string|int, mixed>
Parameters
- $type_saisie : string
-
Le type de la saisie
- $saisies_repertoire : mixed = 'saisies'
Return values
array<string|int, mixed> —Un tableau contenant le YAML décodé
saisies_recuperer_heritage()
Permet à une saisie d'hériter des options et valeur par défaut d'une autre saisies
saisies_recuperer_heritage(string $saisie[, string $saisies_repertoire = 'saisies' ]) : array<string|int, mixed>
Parameters
- $saisie : string
-
la saisie
- $saisies_repertoire : string = 'saisies'
-
= 'saisies'
Return values
array<string|int, mixed>saisies_lister_categories()
Lister les catégories par défaut, puis les envoyer au pipeline
saisies_lister_categories() : array<string|int, mixed>
Return values
array<string|int, mixed> —liste des catégories
saisies_lister_disponibles_par_categories()
Lister les saisies disponibles en les regroupant en catégories
saisies_lister_disponibles_par_categories([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
-
'saisies_repertoire' => string ('saisies') 'inclure_obsoletes' => bool (false) 'categorie' => string|null|false (false) 'uniquement_sql' => bool (false) pour limiter à celle avec sql
Return values
array<string|int, mixed>saisies_lister_disponibles_sql_par_categories()
Liste par catégorie les saisies disponibles ayant une définition SQL
saisies_lister_disponibles_sql_par_categories([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
-
voir saisies_lister_disponibles_par_categories return array
saisies_regrouper_disponibles_par_categories()
Regroupe par categories les saisies
saisies_regrouper_disponibles_par_categories([array<string|int, mixed> $saisies = [] ][, string|null $categorie_demande = null ]) : array<string|int, mixed>
Parameters
- $saisies : array<string|int, mixed> = []
- $categorie_demande : string|null = null
-
pour ne renvoyer que cette catégorie
Return values
array<string|int, mixed>saisies_lister_disponibles_par_categories_usort()
Function de comparaison pour trier les saisies disponibles par rang Si pas de rang défini, on met après ceux avec rang Si deux saisies avec le même rang, on se rabat sur l'ordre alpha
saisies_lister_disponibles_par_categories_usort( $saisie1, $saisie2) : int