saisies_lister.php
Gestion de listes des saisies.
Table of Contents
Functions
- saisies_lister_par_identifiant() : array<string|int, mixed>
- Prend la description complète du contenu d'un formulaire et retourne les saisies "à plat" classées par identifiant unique.
- saisies_lister_par_nom() : array<string|int, mixed>
- Prend la description complète du contenu d'un formulaire et retourne les saisies "à plat" classées par nom.
- saisies_lister_finales() : liste
- Liste les saisies en parcourant tous les niveau de la hiérarchie, et en excluant les saisies ayant des sous-saisies
- saisies_lister_avec_option() : liste
- Liste les saisies ayant une option X # saisies_lister_avec_option('sql', $saisies);.
- saisies_lister_avec_sql() : liste
- Liste les saisies ayant une definition SQL.
- saisies_lister_avec_type() : liste
- Liste les saisies d'un certain type.
- saisies_lister_par_type() : array<string|int, mixed>
- Prend la description complète du contenu d'un formulaire et retourne les saisies "à plat" classées par type de saisie.
- saisies_lister_par_etapes() : array<string|int, mixed>|bool
- Liste les saisies par étapes s'il y en a
- saisies_lister_champs() : array<string|int, mixed>
- Prend la description complète du contenu d'un formulaire et retourne une liste des noms des champs du formulaire.
- saisies_lister_labels() : array<string|int, mixed>
- Prend la description complète du contenu d'un formulaire et retourne une liste des labels humains des vrais champs du formulaire (par nom)
- saisies_charger_champs() : array<string|int, mixed>
- A utiliser dans une fonction charger d'un formulaire CVT, cette fonction renvoie le tableau de contexte correspondant de la forme $contexte['nom_champ'] = ''.
- saisies_lister_valeurs_defaut() : array<string|int, mixed>
- Prend la description complète du contenu d'un formulaire et retourne une liste des valeurs par défaut des champs du formulaire.
- saisies_comparer() : array<string|int, mixed>
- Compare deux tableaux de saisies pour connaitre les différences.
- saisies_comparer_rappel() : int
- Compare deux saisies et indique si elles sont égales ou pas.
- saisies_comparer_par_identifiant() : array<string|int, mixed>
- Compare deux tableaux de saisies pour connaitre les différences en s'appuyant sur les identifiants de saisies.
- saisies_autonomes() : array<string|int, mixed>
- Quelles sont les saisies qui se débrouillent toutes seules, sans le _base commun.
- saisies_chercher() : array<string|int, mixed>
- Cherche une saisie par son id, son nom ou son chemin et renvoie soit la saisie, soit son chemin
- saisies_lister_champs_par_section() : array<string|int, mixed>
- Prend un tableau de saisie retourne un tableau contenant uniquement les champs de saisie organisé par section (fieldset), avec pour chaque saisie le nom de la saisie en clé
Functions
saisies_lister_par_identifiant()
Prend la description complète du contenu d'un formulaire et retourne les saisies "à plat" classées par identifiant unique.
saisies_lister_par_identifiant(array<string|int, mixed> $contenu[, bool $avec_conteneur = true ]) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire
- $avec_conteneur : bool = true
-
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldsets
Return values
array<string|int, mixed> —Un tableau avec uniquement les saisies
saisies_lister_par_nom()
Prend la description complète du contenu d'un formulaire et retourne les saisies "à plat" classées par nom.
saisies_lister_par_nom(array<string|int, mixed> $contenu[, bool $avec_conteneur = true ]) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire
- $avec_conteneur : bool = true
-
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
Return values
array<string|int, mixed> —Un tableau avec uniquement les saisies
saisies_lister_finales()
Liste les saisies en parcourant tous les niveau de la hiérarchie, et en excluant les saisies ayant des sous-saisies
saisies_lister_finales(array<string|int, mixed> $saisies) : liste
Parameters
- $saisies : array<string|int, mixed>
-
Liste de saisies
Return values
liste —de ces saisies triées selon l'ordre de déclaration initiale
saisies_lister_avec_option()
Liste les saisies ayant une option X # saisies_lister_avec_option('sql', $saisies);.
saisies_lister_avec_option(string $option, array<string|int, mixed> $saisies[, string $tri = 'nom' ]) : liste
Parameters
- $option : string
-
Nom de l'option cherchée
- $saisies : array<string|int, mixed>
-
Liste de saisies
- $tri : string = 'nom'
-
tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom', 'identifiant')
Return values
liste —de ces saisies triees par nom ayant une option X définie
saisies_lister_avec_sql()
Liste les saisies ayant une definition SQL.
saisies_lister_avec_sql(array<string|int, mixed> $saisies[, string $tri = 'nom' ]) : liste
Parameters
- $saisies : array<string|int, mixed>
-
liste de saisies
- $tri : string = 'nom'
-
tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom', 'identifiant')
Return values
liste —de ces saisies triees par nom ayant une option sql définie
saisies_lister_avec_type()
Liste les saisies d'un certain type.
saisies_lister_avec_type(array<string|int, mixed> $saisies, string|array<string|int, mixed> $type[, string $tri = 'nom' ][, mixed $avec_conteneur = false ]) : liste
Parameters
- $saisies : array<string|int, mixed>
-
liste de saisies
- $type : string|array<string|int, mixed>
-
Type de la saisie, ou tableau de types
- $tri : string = 'nom'
-
tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom')
- $avec_conteneur : mixed = false
Tags
Return values
liste —de ces saisies triees par nom
saisies_lister_par_type()
Prend la description complète du contenu d'un formulaire et retourne les saisies "à plat" classées par type de saisie.
saisies_lister_par_type(array<string|int, mixed> $contenu) : array<string|int, mixed>
$saisie['input']['input_1'] = $saisie.
Attention : ne sont retournées que les saisies finales (qui ne contiennent pas de sous-saisies).
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire
Return values
array<string|int, mixed> —Un tableau avec uniquement les saisies
saisies_lister_par_etapes()
Liste les saisies par étapes s'il y en a
saisies_lister_par_etapes(array<string|int, mixed> $saisies[, bool $check_only = false ][, array<string|int, mixed>|null $env = [] ]) : array<string|int, mixed>|bool
Parameters
- $saisies : array<string|int, mixed>
-
Liste des saisies
- $check_only : bool = false
-
= false, si true, se contente de vérifier si on gère les étapes, mais ne construit pas le tableau d'étape
- $env : array<string|int, mixed>|null = []
Return values
array<string|int, mixed>|bool —Retourne un tableau associatif par numéro d'étape avec pour chacune leurs saisies (ou bien true si check_only est à true), false si pas d'étapes Retourne un tableau associatif "etape_xxx" => "contenu de l'étape" avec pour chacune leurs saisies, false si pas d'étapes Ajoute si besoin une étape N+1 "Récapitulatif" Les noms des étapes sont automatiquement passés dans _T_ou_typo
saisies_lister_champs()
Prend la description complète du contenu d'un formulaire et retourne une liste des noms des champs du formulaire.
saisies_lister_champs(array<string|int, mixed> $contenu[, bool $avec_conteneur = true ]) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire
- $avec_conteneur : bool = true
-
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
Return values
array<string|int, mixed> —Un tableau listant les noms des champs
saisies_lister_labels()
Prend la description complète du contenu d'un formulaire et retourne une liste des labels humains des vrais champs du formulaire (par nom)
saisies_lister_labels(array<string|int, mixed> $contenu[, bool $avec_conteneur = false ]) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire
- $avec_conteneur : bool = false
-
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
Return values
array<string|int, mixed> —Un tableau listant les labels humains des champs
saisies_charger_champs()
A utiliser dans une fonction charger d'un formulaire CVT, cette fonction renvoie le tableau de contexte correspondant de la forme $contexte['nom_champ'] = ''.
saisies_charger_champs(array<string|int, mixed> $contenu) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire (un tableau de saisies)
Return values
array<string|int, mixed> —Un tableau de contexte
saisies_lister_valeurs_defaut()
Prend la description complète du contenu d'un formulaire et retourne une liste des valeurs par défaut des champs du formulaire.
saisies_lister_valeurs_defaut(array<string|int, mixed> $contenu) : array<string|int, mixed>
Parameters
- $contenu : array<string|int, mixed>
-
Le contenu d'un formulaire
Return values
array<string|int, mixed> —Un tableau renvoyant la valeur par défaut de chaque champs
saisies_comparer()
Compare deux tableaux de saisies pour connaitre les différences.
saisies_comparer(array<string|int, mixed> $saisies_anciennes, array<string|int, mixed> $saisies_nouvelles[, bool $avec_conteneur = true ][, string $tri = 'nom' ]) : array<string|int, mixed>
Parameters
- $saisies_anciennes : array<string|int, mixed>
-
Un tableau décrivant des saisies
- $saisies_nouvelles : array<string|int, mixed>
-
Un autre tableau décrivant des saisies
- $avec_conteneur : bool = true
-
Indique si on veut prendre en compte dans la comparaison les conteneurs comme les fieldsets
- $tri : string = 'nom'
-
Comparer selon quel tri ? 'nom' / 'identifiant'
Return values
array<string|int, mixed> —Retourne le tableau des saisies supprimées, ajoutées et modifiées
saisies_comparer_rappel()
Compare deux saisies et indique si elles sont égales ou pas.
saisies_comparer_rappel(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
- $a : array<string|int, mixed>
-
Une description de saisie
- $b : array<string|int, mixed>
-
Une autre description de saisie
Return values
int —Retourne 0 si les saisies sont identiques, 1 sinon.
saisies_comparer_par_identifiant()
Compare deux tableaux de saisies pour connaitre les différences en s'appuyant sur les identifiants de saisies.
saisies_comparer_par_identifiant(array<string|int, mixed> $saisies_anciennes, array<string|int, mixed> $saisies_nouvelles[, bool $avec_conteneur = true ]) : array<string|int, mixed>
Parameters
- $saisies_anciennes : array<string|int, mixed>
-
Un tableau décrivant des saisies
- $saisies_nouvelles : array<string|int, mixed>
-
Un autre tableau décrivant des saisies
- $avec_conteneur : bool = true
-
Indique si on veut prendre en compte dans la comparaison les conteneurs comme les fieldsets
Tags
Return values
array<string|int, mixed> —Retourne le tableau des saisies supprimées, ajoutées et modifiées
saisies_autonomes()
Quelles sont les saisies qui se débrouillent toutes seules, sans le _base commun.
saisies_autonomes() : array<string|int, mixed>
Return values
array<string|int, mixed> —Retourne un tableau contenant les types de saisies qui ne doivent pas utiliser le _base.html commun
saisies_chercher()
Cherche une saisie par son id, son nom ou son chemin et renvoie soit la saisie, soit son chemin
saisies_chercher(array<string|int, mixed> $saisies, array<string|int, mixed>|string $id_ou_nom_ou_chemin[, bool $retourner_chemin = false ]) : array<string|int, mixed>
Parameters
- $saisies : array<string|int, mixed>
-
Un tableau décrivant les saisies
- $id_ou_nom_ou_chemin : array<string|int, mixed>|string
-
L'identifiant ou le nom de la saisie à chercher ou le chemin sous forme d'une liste de clés
- $retourner_chemin : bool = false
-
Indique si on retourne non pas la saisie mais son chemin
Return values
array<string|int, mixed> —Retourne soit la saisie, soit son chemin, soit null
saisies_lister_champs_par_section()
Prend un tableau de saisie retourne un tableau contenant uniquement les champs de saisie organisé par section (fieldset), avec pour chaque saisie le nom de la saisie en clé
saisies_lister_champs_par_section(array<string|int, mixed> $saisies[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $saisies : array<string|int, mixed>
-
le tableau de saisie
- $options : array<string|int, mixed> = []
-
tableau d'options
- string
callback_sectionnom de la fonction de rappel sur les section, à défaut prend le nom ; exemple :'saisies_saisie_get_label' - string
callback_champnom de la fonction de rappel sur les champ, à défaut renvoie la saisie complète ; exemple :'saisies_saisie_get_label' - int
profondeur_max_outputindique sur combien de niveau doit être le tableau d'output, si pas défini / <= 0 , va jusqu'au bout de la hiérarchie, sinon ca aplatit les niveaux les plus profonds - bool
sans_vide: si True, ne pas renvoyer les section vide - array|string forcer_type: liste de type à prendre, en excluant les autres
- string