saisies_afficher.php
Gestion de l'affichage des saisies.
Table of Contents
Functions
- saisie_editable() : bool
- Indique si une saisie peut être affichée.
- saisies_generer_html() : string
- Génère une saisie à partir d'un tableau la décrivant et de l'environnement.
- saisies_generer_vue() : string
- Génère une vue d'une saisie à partir d'un tableau la décrivant.
- saisies_trouver_erreur() : string
- Récupère l'erreur d'une saisie particulière au sein d'un tableau d'erreur
Functions
saisie_editable()
Indique si une saisie peut être affichée.
saisie_editable(array<string|int, mixed> $champ, array<string|int, mixed> $env[, bool $utiliser_editable = true ]) : bool
On utilise en priorité l'option depublie.
Si activée, la saisie n'est pas affichée sauf si valeur déjà présente.
Mais par compatibilité historique, on peut s'appuyer sur l'éventuelle clé "editable" du $champ. Si editable vaut :
- absent : le champ est éditable
- 1, le champ est éditable
- 0, le champ n'est pas éditable
- -1, le champ est éditable s'il y a du contenu dans le champ (l'environnement) ou dans un de ses enfants (fieldsets)
Parameters
- $champ : array<string|int, mixed>
-
Tableau de description de la saisie
- $env : array<string|int, mixed>
-
Environnement transmis à la saisie, certainement l'environnement du formulaire
- $utiliser_editable : bool = true
-
- false pour juste tester le cas -1
Return values
bool —Retourne un booléen indiquant l'état éditable ou pas :
- true si la saisie est éditable (peut être affichée)
- false sinon
saisies_generer_html()
Génère une saisie à partir d'un tableau la décrivant et de l'environnement.
saisies_generer_html(array<string|int, mixed> $champ[, array<string|int, mixed> $env = [] ]) : string
Parameters
- $champ : array<string|int, mixed>
-
Description de la saisie. Le tableau doit être de la forme suivante : array( 'saisie' => 'input', 'options' => array( 'nom' => 'le_name', 'label' => 'Un titre plus joli', 'obligatoire' => 'oui', 'explication' => 'Remplissez ce champ en utilisant votre clavier.' ) )
- $env : array<string|int, mixed> = []
-
Environnement du formulaire Permet de savoir les valeurs actuelles des contenus des saisies, les erreurs eventuelles présentes...
Return values
string —Code HTML des saisies de formulaire
saisies_generer_vue()
Génère une vue d'une saisie à partir d'un tableau la décrivant.
saisies_generer_vue(array<string|int, mixed> $saisie[, array<string|int, mixed> $env = [] ][, array<string|int, mixed> $env_obligatoire = [] ]) : string
Parameters
- $saisie : array<string|int, mixed>
-
Tableau de description d'une saisie
- $env : array<string|int, mixed> = []
-
L'environnement, contenant normalement la réponse à la saisie
- $env_obligatoire : array<string|int, mixed> = []
-
Ce qui doit toujours être passé à l'environnement
Tags
Return values
string —Code HTML de la vue de la saisie
saisies_trouver_erreur()
Récupère l'erreur d'une saisie particulière au sein d'un tableau d'erreur
saisies_trouver_erreur(array<string|int, mixed>|null $erreurs, string $nom_ou_name) : string
Parameters
- $erreurs : array<string|int, mixed>|null
-
Tableau d'erreurs, 3 formats possibles
-
- Arborescents SPIP 'niveau1/niveau2/niveau3' => 'erreur'
-
- Arborescents HTML 'niveau1[niveau2][niveau3]' => 'erreur'
-
- Arborescents PHP ['niveau1' => ['niveau2' => 'niveau3' => 'erreur']]]
-
- $nom_ou_name : string