_SAISIES_AFFICHER_SI_JS_HIDE
public
mixed
_SAISIES_AFFICHER_SI_JS_HIDE
= 'slideUp(800)'
public
mixed
_SAISIES_AFFICHER_SI_JS_HIDE
= 'slideUp(800)'
public
mixed
_SAISIES_AFFICHER_SI_JS_SHOW
= 'slideDown(800)'
Action de déplacement de saisies dans le constructeur de formulaires
action_deplacer_saisie_dist() : void
Compile la balise `#CONFIGURER_SAISIE`
balise_CONFIGURER_SAISIE_dist(Champ $p) : Champ
Compile la balise `#GENERER_SAISIES` qui retourne le code HTML des saisies de formulaire, à partir du tableau des saisies transmises
balise_GENERER_SAISIES_dist(Champ $p) : Champ
La balise accepte 1 paramètre qui est une liste de descriptions de saisies dont on veut générer le HTML affichant les champs du formulaires
Cette balise est un raccourci :
#GENERER_SAISIES{#TABLEAU_DE_SAISIES}
est équivalent à#INCLURE{fond=inclure/generer_saisies,env,saisies=#TABLEAU_DE_SAISIES}
Pile au niveau de la balise
Pile complété du code à générer
Compile la balise `#SAISIE` qui retourne le code HTML de la saisie de formulaire indiquée.
balise_SAISIE_dist(Champ $p) : Champ
Cette balise incluera le squelette saisies/_base.html
et lui-même saisies/{type}.html
La balise #SAISIE
est un raccourci pour une écriture plus compliquée de la balise #INCLURE
.
La balise calcule une série de paramètre récupérer et à transmettre à #INCLURE
,
en fonction des valeurs des 2 premiers paramètres transmis.
Les autres arguments sont transmis tels quels à la balise #INCLURE
.
Ainsi #SAISIE{input,nom,label=Nom,...}
exécutera l'équivalent de
#INCLURE{nom=nom,valeur=#ENV{nom},type_saisie=input,erreurs,fond=saisies/_base,label=Nom,...}
Compile la balise `#VOIR_SAISIE` qui retourne le code HTML de la vue d'une saisie indiquée
balise_VOIR_SAISIE_dist(Champ $p) : Champ
Cette balise incluera le squelette saisies-vues/_base.html
et lui-même saisies-vues/{type}.html
Compile la balise `#VOIR_SAISIES` qui retourne le code HTML des vues de formulaire, à partir du tableau des saisies transmises
balise_VOIR_SAISIES_dist(Champ $p) : Champ
La balise accepte 2 paramètre :
#VOIR_SAISIES{#TABLEAU_DE_SAISIES}
est équivalent à#INCLURE{fond=inclure/voir_saisies,env,saisies=#TABLEAU_DE_SAISIES,valeurs=#TABLEAU_DE_VALEURS}
Pile au niveau de la balise
Pile complété du code à générer
Déclaration de la balise LISTER_VALEURS pour la saisie `choix_grille`
champs_extras_calculer_balise_LISTER_VALEURS_choix_grille(string $objet, string $colonne, string $cles) : array<string|int, mixed>|string
Type d'objet
Nom de la colonne SQL
Valeurs enregistrées pour ce champ dans la bdd pour l'objet en cours
vide Tableau de type 'Clé de ligne|Valeur de ligne' => 'Ligne en valeur humaine|Valeur de ligne en humain'. Par ex 'Ligne1|Colonne1' => 'Ma première ligne|Ma première colonne'
Sérialise les réponses à un champ extra de type `choix_grille` pour encodage en base.
champs_extras_serialiser_choix_grille(array<string|int, mixed> $extra, array<string|int, mixed> $saisie) : string
La valeur reçue en POST
La description de la saisie
Forme serialisé, en l'occurence avec saisies_tableau2chaine
Saisies du formulaire de configuration de saisies
formulaires_configurer_saisies_saisies_dist() : array<string|int, mixed>
Formulaire permettant de construire un formulaire ! En agençant des champs Chargement.
formulaires_construire_formulaire_charger(string $identifiant[, mixed $formulaire_initial = [] ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
identifiant unique du formulaire
tableau d'options
$contexte
formulaires_construire_formulaire_verifier(mixed $identifiant[, mixed $formulaire_initial = [] ][, mixed $options = [] ]) : mixed
formulaires_construire_formulaire_traiter(mixed $identifiant[, mixed $formulaire_initial = [] ][, mixed $options = [] ]) : mixed
Préparer une saisie pour la transformer en truc configurable
construire_formulaire_generer_saisie_configurable(array<string|int, mixed> $saisie, array<string|int, mixed> $env) : string
description de la saisie
environnement d'appel
fond du formulaire
saisies_groupe_inserer(mixed $formulaire_actuel, mixed $saisie) : mixed
Insérer dans le formulaire de config l'option pour dépublier une saisie
construire_formulaire_config_inserer_option_depublie(array<string|int, mixed> $saisies) : array<string|int, mixed>
formulaires_saisies_cvt_saisies_dist() : mixed
formulaires_saisies_cvt_charger() : mixed
une fonction qui regarde si $texte est une chaine de langue de la forme <:qqch:> si oui applique _T() si non applique typo() suivant le mode choisi
_T_ou_typo(mixed $valeur[, string $mode_typo = 'toujours' ][, mixed $connect = null ][, mixed $env = [] ]) : mixed
Une valeur à tester. Si c'est un tableau, la fonction s'appliquera récursivement dessus.
Le mode d'application de la fonction typo(), avec trois valeurs possibles "toujours", "jamais" ou "multi".
Retourne la valeur éventuellement modifiée.
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 :
Tableau de description de la saisie
Environnement transmis à la saisie, certainement l'environnement du formulaire
Retourne un booléen indiquant l'état éditable ou pas :
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
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.' ) )
Environnement du formulaire Permet de savoir les valeurs actuelles des contenus des saisies, les erreurs eventuelles présentes...
Code HTML des saisies de formulaire
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
Tableau de description d'une saisie
L'environnement, contenant normalement la réponse à la saisie
Ce qui doit toujours être passé à l'environnement
Code HTML de la vue de la saisie
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
Tableau d'erreurs, 3 formats possibles
Normaliser l'option `attributs` d'une saisie individuelle En mergeant les attributs_data
saisies_afficher_normaliser_options_attributs(array<string|int, mixed> $options) : array<string|int, mixed>
liste des options de la saisie
$options liste des options, normalisée
Reçoit une condition la parse pour trouver champs/opérateurs/valeurs etc.
saisies_parser_condition_afficher_si(string $condition[, null|string $no_arobase = null ]) : array<string|int, mixed>
, permet de ne pas parser le arobase
tableau d'analyse (resultat d'un preg_match_all) montrant sous condition par sous condition l'analyse en champ/opérateur/valeur etc.
Filtrer le retour d'un parsage d'un test d'afficher_si, pour ne pas garder des infos qui ne servent pas par là suite.
saisies_afficher_si_filtrer_parse_condition(array<string|int, mixed> $parse) : array<string|int, mixed>
IE : si la REGEXP était optimale, on n'aurait pas besoin de cette fonction Note : on garde les fonctions entrées vides, car parfois besoin de distinguer vide de null
$parse
Retourne le résultat de l'évaluation d'un plugin actif
saisies_afficher_si_evaluer_plugin(string $champ[, string $negation = '' ]) : bool
(sans les @@)
! si on doit nier
'' ('' si jamais on ne teste pas un plugin)
Teste une condition d'afficher_si
saisies_tester_condition_afficher_si(string|array<string|int, mixed> $valeur_champ[, array<string|int, mixed> $modificateur = [] ][, string $operateur = '' ][, string $valeur = '' ][, string $negation = '' ]) : bool
la valeur du champ à tester. Cela peut être :
Fonctions applicables au champ de saisie pour en modifier la valeur
: l'opérateur
la valeur à tester
y-a-t-il un négation avant le test ? '!' si oui
false / true selon la condition
Teste un condition d'afficher_si lorsque la valeur envoyée par le formulaire est une chaîne
saisies_tester_condition_afficher_si_string(string $valeur_champ, array<string|int, mixed> $modificateur, string $operateur, string|int $valeur) : bool
la valeur du champ à tester.
Fonctions applicables au champ de saisie pour en modifier la valeur
: l'opérateur:
la valeur à tester.
false / true selon la condition
Teste un condition d'afficher_si lorsque la valeur postée est un tableau
saisies_tester_condition_afficher_si_array(array<string|int, mixed> $valeur_champ, array<string|int, mixed> $modificateur, string $operateur, string $valeur) : bool
la valeur du champ à tester.
Fonctions applicables au champ de saisie pour en modifier la valeur
: l'opérateur:
la valeur à tester pour un IN. Par exemple "23" ou encore "23,25"
false / true selon la condition
Retourne la valeur d'une config, si nécessaire
saisies_afficher_si_get_valeur_config(string $champ) : string
le "champ" a tester : config:xxx ou un vrai champ
Vérifie qu'une condition est sécurisée IE : ne permet pas d'executer n'importe quel code arbitraire.
saisies_afficher_si_secure(string $condition[, array<string|int, mixed> $tests = [] ]) : bool
tableau des tests parsés
true si secure / false sinon
Vérifie qu'une condition respecte la syntaxe formelle
saisies_afficher_si_verifier_syntaxe(string $condition[, array<string|int, mixed> $tests = [] ]) : bool
liste des tests simples
Décompose une chaine '/regex/modificateur'
saisies_afficher_si_parser_valeur_MATCH(string $valeur) : mixed
Vérifier que les afficher_si dans un tableau de saisies sont cohérents A savoir qu'on ne demande pas un test sur un champ inexistant
saisies_verifier_coherence_afficher_si(array<string|int, mixed> $saisies) : string
erreurs
Vérifie qu'un champ testé dans un `afficher_si` (ce qui est donc entre `@@`) se trouve dans la liste des saisies proposées en tenant compte du fait qu'on peut avoir : - @plugin:xx@ - @config:xxx@ - @choix_grille_1[soustruc]@
saisies_verifier_coherence_afficher_si_par_champ(string $champ, array<string|int, mixed> $saisies_par_nom) : bool
sans les @
d'encadrement
Transforme une condition afficher_si en condition js
saisies_afficher_si_js(string $condition[, array<string|int, mixed> $saisies_par_etapes = [] ]) : string
les saisies du même formulaire, regroupées par etapes. Nécessaire pour savoir quel type de test js on met.
Vérifier qu'un test JS d'afficher si est statique, c'est à dire qu'il ne dépend d'aucune saisie de l'étape en cours.
saisies_afficher_si_js_est_statique(mixed $test) : bool
Exemple
false && false
=> statique, la fonction renvoie true
true && afficher_si(...)
=> pas statique, la fonction renvoie false
Traitement des saisies ayant l'option `afficher_si`.
saisies_verifier_afficher_si(array<string|int, mixed> $saisies[, array<string|int, mixed>|null $env = null ][, array<string|int, mixed> $saisies_toutes_par_nom = [] ]) : array<string|int, mixed>
Lorsque qu'on affiche les saisies avec #VOIR_SAISIES
,
ou lorsqu'on les vérifie avec saisies_verifier().
Si la condition d'affichage d'une saisie n'est pas remplie, on retire cette saisie du tableau de saisies, SAUF SI l'option afficher_si_remplissage_uniquement
est activée et que $env
est non null.
Tableau de descriptions de saisies
Tableau d'environnement transmis dans inclure/voir_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).
ensemble des saisies du formulaire courant, quelque soit le niveau de profondeur dans l'arborescence des saisies. A passer uniquement lorsque la fonction s'appelle elle-même, pour gérer la récursion
Tableau de descriptions de saisies
Recherche les saisies qui ont été masquées par afficher_si et les mets à `''`, sauf si * - options globales de saisies : `afficher_si_avec_post` * - option de la saisie spécifique : `afficher_si_avec_post` Cette fonction est appelée à la toute fin de `saisies_verifier()`
saisies_afficher_si_masquees_set_request_empty_string(mixed $saisies[, mixed $valeurs = null ]) : mixed
Pose un set_request sur une saisie et toute ses sous-saisies.
saisies_set_request_recursivement(array<string|int, mixed> $saisie[, null|string|array<string|int, mixed> $val = '' ][, array<string|int, mixed> $valeurs = null ]) : mixed
Utiliser notamment pour annuler toutes les sous saisies d'un fieldeset si le fieldset est masquée à cause d'un afficher_si.
(defaut ''
)
Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST
Récupère la valeur d'un champ à tester avec afficher_si Si le champ est de type @config:xx@, alors prend la valeur de la config Si le champ est de type @plugin:xx@, vérifier si le plugin est actif Sinon en _request() ou en $env["valeurs"]
saisies_afficher_si_get_valeur_champ(string $champ, null|array<string|int, mixed> $env, array<string|int, mixed> $saisies_par_nom) : null|mixed
Les saisies déjà classées par nom de champ
la valeur du champ ou de la config
Prend un test conditionnel, le sépare en une série de sous-tests de type champ - operateur - valeur remplace chacun de ces sous-tests par son résultat renvoie la chaine transformé
saisies_transformer_condition_afficher_si(string $condition[, array<string|int, mixed>|null $env = null ][, array<string|int, mixed> $saisies_par_nom = [] ][, string|null $no_arobase = null ]) : string
Tableau d'environnement transmis dans inclure/voir_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).
Les saisies déjà classées par nom de champ
une valeur à tester là où il devrait y avoir un @@
$condition
Evalue un afficher_si
saisies_evaluer_afficher_si(string $condition[, array<string|int, mixed>|null $env = null ][, array<string|int, mixed> $saisies_par_nom = [] ][, string|null $no_arobase = null ]) : bool
Tableau d'environnement transmis dans inclure/voir_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).
Les saisies déjà classées par nom de champ
une valeur à tester là où il devrait y avoir un @@
le résultat du test
Liste des saisies masquées par afficher_si dans le hit courant
saisies_afficher_si_liste_masquees([string $action = 'get' ][, array<string|int, mixed> $saisie = '' ]) : array<string|int, mixed>|null
('set'|'get'), defaut 'get';
complète
Génère une page d'aide listant toutes les saisies et leurs options
saisies_generer_aide() : string
Retourne le résultat du squelette inclure/saisies_aide
auquel
on a transmis toutes les saisies connues.
Code HTML
Aplatit une description chaînée, en supprimant les sous-groupes.
saisies_aplatir_chaine(string $chaine) : string
La chaîne à aplatir
Transforme une chaine en tableau avec comme principe :
saisies_chaine2tableau(string $chaine[, string $separateur = "
" ]) : array<string|int, mixed>
Une chaine à transformer
Séparateur utilisé
Retourne un tableau PHP
Transforme un tableau en chaine de caractères avec comme principe :
saisies_tableau2chaine(array<string|int, mixed> $tableau) : string
Tableau à transformer
Texte représentant les données du tableau
Transforme une valeur en tableau d'élements si ce n'est pas déjà le cas
saisies_valeur2tableau(mixed $valeur[, array<string|int, mixed> $data = [] ]) : array<string|int, mixed>
Options data
de la saisie
Tableau de valeurs
Pour les saisies multiples (type checkbox) proposant un choix alternatif, retrouve à partir des data de choix proposés et des valeurs des choix enregistrés le texte enregistré pour le choix alternatif.
saisies_trouver_choix_alternatif(array<string|int, mixed> $data, array<string|int, mixed> $valeur) : string
choix_alternatif
Aplatit une description tabulaire en supprimant les sous-groupes.
saisies_aplatir_tableau(array<string|int, mixed> $tab[, bool $masquer_sous_groupe = false ]) : array<string|int, mixed>
Ex : les data d'une saisie de type select
Le tableau à aplatir
mettre à true pour ne pas montrer le sous-groupe dans les label humain
Trouve le champ data ou datas (pour raison historique) parmi les paramètres d'une saisie et le retourne après avoir l'avoir transformé en tableau si besoin
saisies_trouver_data(array<string|int, mixed> $description[, mixed $disable_choix = false ]) : array<string|int, mixed>
description de la saisie
data
Prend une liste de choix (clés de tableau data) en entrée Si tableau, renvoi presque tel quel Si chaine, l'explose au niveau des virgules Trim dans tous les cas les différents choix
saisies_normaliser_liste_choix(array<string|int, mixed>|string $liste) : array<string|int, mixed>
Ancien nom de la fonction saisies_normaliser_liste_choix
saisies_normaliser_disable_choix(array<string|int, mixed>|string $liste) : array<string|int, mixed>
Prend un tableau de data enlève les choix dépubliés sauf si la valeur courante de la saisie
saisies_depublier_data([mixed $data = [] ][, array<string|int, mixed>|string $depublie_choix = [] ][, array<string|int, mixed>|string $valeur = [] ]) : array<string|int, mixed>
Return la liste des saisies qui nécessite qu'on insère un hidden avec les précédentes valeurs.
saisies_lister_necessite_retenir_ancienne_valeur(array<string|int, mixed> $saisies) : array<string|int, mixed>
C'est à dire : uniquement les saisies qui sont des depublies et sousmis à test de valeurs_acceptables
description complète de saisies
$liste_saisies
Cherche la description des saisies d'un formulaire CVT dont on donne le nom
saisies_chercher_formulaire(string $form, array<string|int, mixed> $args[, mixed $je_suis_poste = false ]) : array<string|int, mixed>
Nom du formulaire dont on cherche les saisies
Tableau d'arguments du formulaire
Retourne les saisies du formulaire sinon false
Génère un nom unique pour un champ d'un formulaire donné
saisies_generer_nom(array<string|int, mixed> $formulaire, string $type_saisie) : string
Le formulaire à analyser
Le type de champ dont on veut un identifiant
Un nom unique par rapport aux autres champs du formulaire
Détermine si peut faire une avance rapide en sautant des étapes qui sont "masquées" par afficher_si
saisies_determiner_avance_rapide(array<string|int, mixed> $saisies, int $etape) : int
le tableau d'ensemble des saisies
l'étape à partir de laquelle on commence à tester les étapes suivantes
l'étape où avancer
Détermine si peut faire un recul rapide en sautant des étapes qui sont "masquées" par afficher_si
saisies_determiner_recul_rapide(array<string|int, mixed> $saisies, int $etape) : int
le tableau d'ensemble des saisies
l'étape à partir de laquelle on commence à tester les étapes précédentes
l'étape où avancer
Détermine si peut faire un déplacement rapide en sautant des étapes qui sont "masquées" par afficher_si Pour le confort de lecture, on pourra préférer les fonctions appellantes `saisies_determiner_avance_rapide()` et `saisies_determiner_recul_rapide()`
saisies_determiner_deplacement_rapide(array<string|int, mixed> $saisies, int $etape, int $sens) : int
le tableau d'ensemble des saisies, potentiellement déjà classées par étapes
l'étape à partir de laquelle on commence à tester les étapes suivantes
1 (avance) ou -1 (recule)
l'étape où avancer
Retourne un résumé des étapes futures (qu'elles s'afficheront finalement ou pas).
saisies_resumer_etapes_futures(array<string|int, mixed> $etapes, int $etape, array<string|int, mixed> $options_demandees) : array<string|int, mixed>
liste des étapes (sous forme de tableau de saisies)
etape courante
tableau décrivant les options qu'on demande
[ 'etape_n' => ['info_x' => 'valeur_x', 'info_y' => 'valeur_y' …] … ]
Détermine quels options d'étapes sont utiles au résumé des étapes futures En fonction des options globales du formulaire
saisies_determiner_options_demandees_resumer_etapes_futures(array<string|int, mixed> $options_globales) : array<string|int, mixed>
optiosn globales du formulaire
liste des options à garder
Crée un identifiant Unique pour la saisie donnee si elle n'en a pas (et pour ses sous saisies éventuels)
saisie_identifier(array<string|int, mixed> $saisie[, bool $regenerer = false ]) : array<string|int, mixed>
Tableau d'une saisie
Régénère un nouvel identifiant pour la saisie ?
Tableau de la saisie complété de l'identifiant
Crée un identifiant Unique pour toutes les saisies donnees qui n'en ont pas
saisies_identifier(array<string|int, mixed> $saisies[, bool $regenerer = false ]) : array<string|int, mixed>
Tableau de saisies
Régénère un nouvel identifiant pour toutes les saisies ?
Tableau de saisies complété des identifiants
Supprimer récursivement les identifiants d'un tableau de saisie Seul usage probable : pour les test uniaires pour la saisie donnee si elle n'en a pas (et pour ses sous saisies éventuels)
saisies_supprimer_identifiants(mixed $saisies) : array<string|int, mixed>
Tableau de la saisie sans les identifiant
La saisie renvoie t-elle un tableau? note: on teste saisie par saisie, et non pas type de saisie par type de saisie, car certains types (`selection` par ex.) peuvent, en fonction des options, être tabulaire ou pas.
saisies_saisie_est_tabulaire(mixed $saisie) : return
bool true si la saisie est tabulaire, false sinon
La saisie remplie-t-elle `$_FILES` ? note: on teste saisie par saisie, et non pas type de saisie par type de saisie, car certains types (`input` par ex.) peuvent, en fonction des options, être fichier ou pas.
saisies_saisie_est_fichier(array<string|int, mixed> $saisie) : bool
Indique si une saisie à sa valeur gelée - soit par option disabled avec envoi cachée - soit par option readonly
saisies_saisie_est_gelee(array<string|int, mixed> $description) : bool
description de la saisie
true si gélée, false sinon)
saisies_verifier_gel_saisie Renommée en saisies_saisie_est_gelee
saisies_verifier_gel_saisie(array<string|int, mixed> $description) : bool
Renvoie true si la saisie est un conteneur de sous saisies, qu'elle contienne effectivement des sous saisies ou pas
saisies_saisie_est_avec_sous_saisies(array<string|int, mixed> $saisie) : bool
Renvoie true si la saisie peut recevoir un label, qu'elle contienne effectivement un label ou pas
saisies_saisie_est_labelisable(array<string|int, mixed> $saisie) : bool
Renvoie true si la saisie correspond à un champ au sens HTML
saisies_saisie_est_champ(array<string|int, mixed> $saisie) : bool
Renvoi le label de la saisie la plupart du temps c'est juste le champ label mais pour certaines saisies c'est autre chose
saisies_saisie_get_label(array<string|int, mixed> $saisie) : string
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>
Le contenu d'un formulaire
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldsets
Un tableau avec uniquement les saisies
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>
Le contenu d'un formulaire
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
Un tableau avec uniquement les saisies
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
Liste de saisies
de ces saisies triées selon l'ordre de déclaration initiale
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
Nom de l'option cherchée
Liste de saisies
tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom', 'identifiant')
de ces saisies triees par nom ayant une option X définie
Liste les saisies ayant une definition SQL.
saisies_lister_avec_sql(array<string|int, mixed> $saisies[, string $tri = 'nom' ]) : liste
liste de saisies
tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom', 'identifiant')
de ces saisies triees par nom ayant une option sql définie
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
liste de saisies
Type de la saisie, ou tableau de types
tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom')
de ces saisies triees par nom
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).
Le contenu d'un formulaire
Un tableau avec uniquement les saisies
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
Liste des saisies
= false, si true, se contente de vérifier si on gère les étapes, mais ne construit pas le tableau d'étape
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
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>
Le contenu d'un formulaire
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
Un tableau listant les noms des champs
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>
Le contenu d'un formulaire
Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
Un tableau listant les labels humains des 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>
Le contenu d'un formulaire (un tableau de saisies)
Un tableau de contexte
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>
Le contenu d'un formulaire
Un tableau renvoyant la valeur par défaut de chaque champs
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>
Un tableau décrivant des saisies
Un autre tableau décrivant des saisies
Indique si on veut prendre en compte dans la comparaison les conteneurs comme les fieldsets
Comparer selon quel tri ? 'nom' / 'identifiant'
Retourne le tableau des saisies supprimées, ajoutées et modifiées
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
Une description de saisie
Une autre description de saisie
Retourne 0 si les saisies sont identiques, 1 sinon.
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>
Un tableau décrivant des saisies
Un autre tableau décrivant des saisies
Indique si on veut prendre en compte dans la comparaison les conteneurs comme les fieldsets
Retourne le tableau des saisies supprimées, ajoutées et modifiées
Quelles sont les saisies qui se débrouillent toutes seules, sans le _base commun.
saisies_autonomes() : array<string|int, mixed>
Retourne un tableau contenant les types de saisies qui ne doivent pas utiliser le _base.html commun
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>
Un tableau décrivant les saisies
L'identifiant ou le nom de la saisie à chercher ou le chemin sous forme d'une liste de clés
Indique si on retourne non pas la saisie mais son chemin
Retourne soit la saisie, soit son chemin, soit null
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>
le tableau de saisie
tableau d'options
callback_section
nom de la fonction de rappel sur les section, à défaut prend le nom ; exemple : 'saisies_saisie_get_label'
callback_champ
nom de la fonction de rappel sur les champ, à défaut renvoie la saisie complète ; exemple : 'saisies_saisie_get_label'
profondeur_max_output
indique 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 profondssans_vide
: si True, ne pas renvoyer les section videIndique si dans une liste de saisies, au moins l'une d'entre elle possède l'option `$option` Optimisée par rapport à `saisies_lister_avec_option()` car s'arrête de parcourir dès la première saisies trouvée
saisies_dont_avec_option([array<string|int, mixed> $saisies = [] ][, string $option = '' ]) : bool
Liste toutes les saisies configurables (ayant une description).
saisies_lister_disponibles([string $saisies_repertoire = 'saisies' ][, bool $inclure_obsoletes = true ]) : array<string|int, mixed>
le répertoire où trouver les saisies
: faut-il inclure les saisies obsolètes ?
Un tableau listant des saisies et leurs options
Liste tous les groupes de saisies configurables (ayant une description).
saisies_groupes_lister_disponibles([mixed $saisies_repertoire = 'saisies' ]) : array<string|int, mixed>
Un tableau listant des saisies et leurs options
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>
le répertoire où trouver les saisies
: faut-il inclure les saisies obsolètes ?
Un tableau listant des saisies et leurs options
Charger les informations contenues dans le YAML d'une saisie.
saisies_charger_infos(string $type_saisie[, mixed $saisies_repertoire = 'saisies' ]) : array<string|int, mixed>
Le type de la saisie
Un tableau contenant le YAML décodé
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>
la saisie
= 'saisies'
Lister les catégories par défaut, puis les envoyer au pipeline
saisies_lister_categories() : array<string|int, mixed>
liste des catégories
Lister les saisies disponibles en les regroupant en catégories
saisies_lister_disponibles_par_categories([array<string|int, mixed> $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
Liste par catégorie les saisies disponibles ayant une définition SQL
saisies_lister_disponibles_sql_par_categories([array<string|int, mixed> $options = [] ]) : mixed
voir saisies_lister_disponibles_par_categories return array
Regroupe par categories les saisies
saisies_regrouper_disponibles_par_categories([array<string|int, mixed> $saisies = [] ][, string|null $categorie_demande = null ]) : array<string|int, mixed>
pour ne renvoyer que cette catégorie
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(mixed $saisie1, mixed $saisie2) : int
Supprimer une saisie dont on donne l'identifiant, le nom ou le chemin.
saisies_supprimer(array<string|int, mixed> $saisies, string|array<string|int, mixed> $id_ou_nom_ou_chemin) : array<string|int, mixed>
Tableau des descriptions de saisies
L'identifiant unique ou le nom de la saisie à supprimer ou son chemin sous forme d'une liste de clés
Tableau modifié décrivant les saisies
Insère une saisie à une position donnée dans un tableau de donnée - soit en lui passant un chemin - soit en lui passant une saisie devant laquelle se placer
saisies_inserer(array<string|int, mixed> $saisies, array<string|int, mixed> $saisie[, array<string|int, mixed>|string $id_ou_nom_ou_chemin = [] ]) : array<string|int, mixed>
Tableau des descriptions de saisies
Description de la saisie à insérer
[fieldset]
[fieldset][0]
saisie
Tableau des saisies complété de la saisie insérée
Insère une saisie avant une autre saisie.
saisies_inserer_avant(array<string|int, mixed> $saisies, array<string|int, mixed> $saisie, array<string|int, mixed> $id_ou_nom_ou_chemin) : array<string|int, mixed>
Tableau des descriptions de saisies
Description de la saisie à insérer
identifiant ou nom ou chemin de la saisie devant laquelle inserer
Tableau des saisies complété de la saisie insérée
Insère une saisie après une autre saisie.
saisies_inserer_apres(array<string|int, mixed> $saisies, array<string|int, mixed> $saisie, array<string|int, mixed> $id_ou_nom_ou_chemin) : array<string|int, mixed>
Tableau des descriptions de saisies
Description de la saisie à insérer
identifiant ou nom ou chemin de la saisie derrière laquelle inserer
Tableau des saisies complété de la saisie insérée
Insère une saisie à une position donnée, en lui passant un chemin.
saisies_inserer_selon_chemin(array<string|int, mixed> $saisies, array<string|int, mixed> $saisie[, array<string|int, mixed> $chemin = [] ]) : array<string|int, mixed>
Tableau des descriptions de saisies
Description de la saisie à insérer
Position complète où insérer la saisie
Tableau des saisies complété de la saisie insérée
Duplique une saisie (ou groupe de saisies) en placant la copie à la suite de la saisie d'origine.
saisies_dupliquer(array<string|int, mixed> $saisies, unknown_type $id_ou_nom_ou_chemin) : array<string|int, mixed>
Modifie automatiquement les identifiants des saisies.
Un tableau décrivant les saisies
L'identifiant unique ou le nom ou le chemin de la saisie a dupliquer
Retourne le tableau modifié des saisies
Déplace une saisie existante autre part.
saisies_deplacer(array<string|int, mixed> $saisies, unknown_type $id_ou_nom_ou_chemin, string $ou[, string $avant_ou_apres = 'avant' ]) : array<string|int, mixed>
Un tableau décrivant les saisies
L'identifiant unique ou le nom ou le chemin de la saisie à déplacer
(optionel) : valeur possible : 'avant'
ou 'apres'
, pour inserer respectivent avant/après la saisie $ou
Retourne le tableau modifié des saisies
Déplacer une saisie existante avant une autre
saisies_deplacer_avant(array<string|int, mixed> $saisies, unknown_type $id_ou_nom_ou_chemin, string $ou) : array<string|int, mixed>
Un tableau décrivant les saisies
L'identifiant unique ou le nom ou le chemin de la saisie à déplacer
la saisie devant laquelle déplacer
$string
Déplacer une saisie existante après une autre
saisies_deplacer_apres(array<string|int, mixed> $saisies, unknown_type $id_ou_nom_ou_chemin, string $ou) : array<string|int, mixed>
Un tableau décrivant les saisies
L'identifiant unique ou le nom ou le chemin de la saisie à déplacer
la saisie devant laquelle déplacer
$string
Modifie une saisie.
saisies_modifier(array<string|int, mixed> $saisies, array<string|int, mixed>|string $id_ou_nom_ou_chemin, array<string|int, mixed> $modifs[, bool $fusion = false ]) : array<string|int, mixed>
Un tableau décrivant les saisies
L'identifiant unique ou le nom ou le chemin de la saisie à modifier
Le tableau des modifications à apporter à la saisie
True si on veut simplifier rajouter des choses, sans tout remplacer
Retourne le tableau décrivant les saisies, mais modifié
Transforme tous les noms du formulaire avec un preg_replace.
saisies_transformer_noms(array<string|int, mixed> $saisies, string $masque, string $remplacement) : array<string|int, mixed>
Un tableau décrivant les saisies
Ce que l'on doit chercher dans le nom
Ce par quoi on doit remplacer
Retourne le tableau modifié des saisies
Transforme tous les noms en les encapsulant avec un préfixe.
saisies_encapsuler_noms(array<string|int, mixed> $saisies, string $prefixe[, bool $recursif = true ]) : array<string|int, mixed>
Cela permet d'avoir toutes les valeurs postées dans un unique tableau.
Après transformation, on pourra faire _request(<prefixe>)
pour les récupérer.
Utilisation possible : on mélange les saisies de plusieurs formulaires, et on a dans ce cas besoin de cloisonner les valeurs.
Un tableau décrivant les saisies
Préfixe
Pour procéder récursivement dans les fieldsets
Transforme toutes les options textuelles d'un certain nom, avec un preg_replace.
saisies_transformer_option(mixed $saisies, mixed $option, mixed $masque, mixed $remplacement[, bool $recursif = true ]) : array<string|int, mixed>
Tableau décrivant les saisies
Nom de l'option à transformer (par ex "nom", ou "afficher_si"), ou tableau
Note : si l'option n'existe pas, elle est automatiquement mise à ''
avant toute transformation
Ce que l'on doit chercher dans le texte
Ce par quoi on doit remplacer
Retourne le tableau modifié des saisies
Modifie toutes les options d'un certain nom, avec une fonction de rappel.
saisies_mapper_option(array<string|int, mixed> $saisies, string|array<string|int, mixed> $options, string $callback[, array<string|int, mixed> $args = [] ][, bool $recursif = true ]) : array<string|int, mixed>
Tableau décrivant les saisies
Nom de l'option à transformer (par ex "nom", ou "afficher_si")
Ou tableau de noms
Note : si l'option n'existe pas, elle est automatiquement mise à ''
avant toute transformation
Nom de la fonction à appliquer
Arguments de la fonction de rappel La valeur de l'option est passée automatiquement en premier
=True
Retourne le tableau modifié des saisies
Supprime toutes les options d'un certain nom.
saisies_supprimer_option(mixed $saisies, mixed $option[, bool $recursif = true ]) : array<string|int, mixed>
Tableau décrivant les saisies
Nom de l'option à supprimer (par ex "nom", ou "afficher_si")
Retourne le tableau modifié des saisies
Modifie les vérifications des saisies avec une fonction de rappel
saisies_mapper_verifier(array<string|int, mixed> $saisies, string $callback[, array<string|int, mixed> $args = [] ][, bool $recursif = true ]) : array<string|int, mixed>
Tableau décrivant les saisies
Nom de la fonction à appliquer, elle doit retourner la nouvelle version du tableau de vérification
Arguments supplémentaires passées à la fonction de rappel
=True
Retourne le tableau modifié des saisies
Transforme les noms d'une liste de saisies pour qu'ils soient uniques dans le formulaire donné.
saisies_transformer_noms_auto(array<string|int, mixed> $formulaire, array<string|int, mixed> $saisies) : array<string|int, mixed>
Le formulaire à analyser
Un tableau décrivant les saisies.
Retourne le tableau modifié des saisies
Insère du HTML au début ou à la fin d'une saisie.
saisies_inserer_html(array<string|int, mixed> $saisie, string $insertion[, string $ou = 'fin' ]) : array<string|int, mixed>
La description d'une seule saisie
Du code HTML à insérer dans la saisie
L'endroit où insérer le HTML : "debut" ou "fin"
Retourne la description de la saisie modifiée
Ajoute l'option onglet aux fieldset de premier niveau dans un tableau de $saisie Ajoute également un identifiant unique, éventuellement préfixé
saisies_fieldsets_en_onglets(array<string|int, mixed> $saisies[, string $identifiant_prefixe = '' ][, bool $vertical = false ]) : array<string|int, mixed>
$saisies modifiées
Prend un tableau de saisies Enlève les saisies qui n'ont rien dans _request Ou dont l'ensemble des sous-saisies sont vides
saisies_supprimer_sans_reponse(array<string|int, mixed> $saisies[, optional $tableau = null ]) : array<string|int, mixed>
(tableau pour chercher dans request)
Indique si une saisie possède une réponse
saisies_saisie_possede_reponse(array<string|int, mixed> $saisie[, null|array<string|int, mixed> $tableau = null ]) : bool
la saisie individuelle
(tableau pour chercher les valeurs, à défaut request
Prend un tableau de saisies Enlève les saisies dépubliées Ou dont l'ensemble des sous-saisies sont dépubliés
saisies_supprimer_depublie(array<string|int, mixed> $saisies) : array<string|int, mixed>
Prend un tableau de saisies Enlève les saisies dépubliées Et qui n'ont pas de réponse Ou dont l'ensemble des saisies répondent au critère ci-dessus
saisies_supprimer_depublie_sans_reponse(array<string|int, mixed> $saisies[, array<string|int, mixed>|null $reponses = null ]) : array<string|int, mixed>
null pour chercher dans _request
Prend un tableau de saisies supprime les saisies selon une fonction de rappel
saisies_supprimer_callback(array<string|int, mixed> $saisies, callable $callback) : array<string|int, mixed>
tableau de saisies
fonction de rappel
la fonction doit renvoyer true
si on garde, false
sinon
Transforme un tableau de saisies en englobant le tout dans un fieldset utilisé pour la prévisualisation
saisies_wrapper_fieldset(array<string|int, mixed> $saisies, array<string|int, mixed> $options) : array<string|int, mixed>
du fieldset
Parcours un tableau de saisies, regarde si on a un champ afficher_si_remplissage et le transforme en champs afficher_si + afficher_si_remplissage_uniquement
saisies_migrer_afficher_si_remplissage(array<string|int, mixed> $saisies) : array<string|int, mixed>
Les saisies initiales
$saisies Les saisies modifiées
Passer un nom en une valeur compatible avec une classe css
saisie_nom2classe(string $nom) : string
Ajouter une ou des classes sur la saisie en fonction du type
saisie_type2classe(mixed $type_saisie) : string
Passer un nom en une valeur compatible avec un `name` de formulaire
saisie_nom2name(string $nom) : string
Passer un `name` en un format de nom compris de saisies
saisie_name2nom(string $name) : string
Appliquer `saisie_nom2name()` sur les clés d'un tableau utilisé pour gérer les erreurs
saisies_cles_nom2name(array<string|int, mixed> $tab) : array<string|int, mixed>
Suffixe un name en tenant compte du fait que cela peut être potentiellement avec des []
saisies_name_suffixer(string $name, string $suffixe) : string
(sans _
qui sera mis automatiquement)
nouvelle version
Enelever le suffixe d'un name, en tenant compte du fait que cela peut potentiellement être avec des []
saisies_name_supprimer_suffixe(string $name, string $suffixe) : string
(sans le _
)
$name sans le suffixe
Trouve le résultat d'une saisie (`_request()`) en tenant compte du fait que la saisie peut être décrite sous forme de sous entrées d'un tableau - soit `toto[truc][bidule]` - soit `toto/truc/bidule`
saisies_request(string $champ[, null|array<string|int, mixed> $valeurs = null ]) : string|array<string|int, mixed>
Nom du champ de la saisie, y compris avec crochets pour sous entrées
Tableau où chercher, à defaut get/post
Résultat du _request()
Trouve le sous tableau de $_FILES correspondant à champ, en prenant en compte CVT-Upload
saisies_request_from_FILES(string $champ) : array<string|int, mixed>|null
Trouve une propriété d'un fichier uploadé au sein d'un $_FILES en tenant compte du fait que la saisie peut être décrit sous forme de sous entrées d'un tableau ET que dans ce cas la structure PHP de $_FILES est totalement aberrant
saisies_request_property_from_FILES(string $champ[, string $property = 'name' ]) : string|array<string|int, mixed>
Nom du champ de la saisie, y compris avec crochets pour sous entrées
Résultat du _request()
Modifie la valeur d'un saisie postée en tenant compte que ça puisse être un tableau - soit `toto[truc][bidule]` - soit `toto/truc/bidule`
saisies_set_request(mixed $champ, mixed $valeur[, array<string|int, mixed> $valeurs = null ]) : void
Valeur à remplir dans le request
Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST
Pour chaque champ, sauvegarde l'historique de ses valeurs avant que set_request Utilisé notamment par formidable pour trouver les saisies qui été mises à ''
saisies_liste_set_request([string $action = 'set' ][, string $champ = 'null' ][, string $nouvelle_valeur = '' ][, array<string|int, mixed> $valeurs = null ]) : array<string|int, mixed>
'set|get'
Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST
(si action = get) un tableau associatif
Chercher la valeur d'une saisie, en tenant compte du fait que potentiellement c'est une saisies fichiers
saisies_get_valeur_saisie(array<string|int, mixed> $saisie[, array<string|int, mixed> $valeurs = null ]) : string|array<string|int, mixed>
$valeur Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST
Vérifier tout un formulaire tel que décrit avec les Saisies
saisies_verifier(array<string|int, mixed> $formulaire[, bool $saisies_masquees_empty_string = true ][, mixed $etape = null ][, array<string|int, mixed> $valeurs = null ]) : array<string|int, mixed>
Le formulaire à vérifier, c'est à dire un tableau de saisies, avec éventuellement une clé options, comprenant tout les étapes
Si true, les saisies masquées selon afficher_si ne sont pas verifiées.
/!\ Dans tous les cas ces saisies sont mises à ''
à la fin de des tests, si aucune erreur.
l'étape courante à vérifier
Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST
Retourne un tableau d'erreurs
Vérifier que les valeurs postées sont acceptables, c'est-à-dire qu'elles ont été proposées lors de la conception de la saisie.
saisies_verifier_valeurs_acceptables(mixed $saisies, mixed $erreurs) : array<string|int, mixed>
Typiquement pour une saisie radio, vérifier que les gens n'ont pas postée une autre fleur.
array tableau général des saisies, déjà aplati, classé par nom de champ
array tableau des erreurs
table des erreurs modifiés
Prend un tableau de saisies et applique l'option `depublie` à toutes les sous-saisies d'une saisie dépubliée
saisies_appliquer_depublie_recursivement(array<string|int, mixed> $saisies[, string $depublie = '' ]) : array<string|int, mixed>
Verifier si une saisie individuelle remplit les conditions d'obligation en tenant compte du fait que la valeur envoyé peut être : 1. Un tableau 2. Un fichier 3. Une chaine
saisies_saisie_verifier_obligatoire(array<string|int, mixed> $saisie, mixed $valeur) : string
message d'erreur ou ''
construire_configuration_saisie(mixed $saisie[, mixed $avec_nom = 'non' ]) : mixed
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
auteurs_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
case_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Retourne le label de la saisie `case` Par ordre de priorité le `label_case` sinon le `label`
case_get_label(array<string|int, mixed> $saisie) : string
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
checkbox_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
choix_grille_valeurs_acceptables(array<string|int, mixed> $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Un conteneur_inline, c'est une saisie contenante
conteneur_inline_est_avec_sous_saisies(array<string|int, mixed> $saisie) : bool
true
Un conteneur_inline, ca n'a pas de label
conteneur_inline_est_labelisable(array<string|int, mixed> $saisie) : bool
false
Un conteneur_inline, ca n'est pas un champ
conteneur_inline_est_champ(array<string|int, mixed> $saisie) : bool
false
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
date_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
email_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Une explication, ca n'est pas un champ
explication_est_champ(array<string|int, mixed> $saisie) : bool
false
Retourne le label de la saisie `explication` Par ordre de priorité le `titre` sinon le `texte`
explication_get_label(array<string|int, mixed> $saisie) : string
Un fieldset, c'est une saisie contenante
fieldset_est_avec_sous_saisies(array<string|int, mixed> $saisie) : bool
true
Un fieldset, ca n'est pas un champ
fieldset_est_champ(array<string|int, mixed> $saisie) : bool
false
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
hidden_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
input_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
oui_non_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
radio_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
selection_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
selection_multiple_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
textarea_valeurs_acceptables(string $valeur, array<string|int, mixed> $description) : bool
la valeur postée
la description de la saisie
true si valeur ok, false sinon,
Remplit un tableau de description de types mime Sous la forme type_mime => 'Nom du type (extensions)'
remplir_tableau_mime(array<string|int, mixed> $tableau, string $mime, string $titre, string $extension) : array<string|int, mixed>
le tableau en l'état actuel
le type mime qu'on veut mettre à jour
le titre associé au type mime
une extension associé au type mime
le tableau modifié
Installation/maj des config de saisies
saisies_upgrade(string $nom_meta_base_version, string $version_cible) : void
Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
Corrige une honteuse coquille
saisies_corriger_assests() : mixed
saisies_vider_tables(mixed $nom_meta_base_version) : mixed
Generation du js d'afficher_si par défaut
saisies_afficher_si_js_defaut(array<string|int, mixed> $parse, array<string|int, mixed> $saisies_form) : mixed
analyse syntaxique du tests à effectuer (sous tableau de résultat de saisies_parser_condition_afficher_si())
ensemble des saisies du formulaire, listées par nom
Retourne une balise dev. Maintenu pour compatibilité historique, ne plus utiliser.
Comportement antérieure :
Retournait une balise div
si on est en SPIP >= 3.1, sinon le texte en parametre.
saisie_balise_structure_formulaire(mixed $tag) : string
ul ou li
$tag initial ou div
Compile la balise `DIV` qui retourne simplement le texte `div`
balise_DIV_dist(Pile $p) : Pile
Maintenu pour ne pas casser les squelettes qui s'appuient dessus, mais à ne plus utiliser. Servait à la compatibilité entre SPIP 3.0 et SPIP 3.1+
Variante d'écriture, plus courte, que le filtre saisie_balise_structure_formulaire
À partir de SPIP 3.1
Traiter la valeur de la vue en fonction du env si un traitement a ete fait en amont (champs extra) ne rien faire si pas de traitement defini (formidable) passer typo ou propre selon le type du champ
saisie_traitement_vue(string|null $valeur, string|array<string|int, mixed> $env) : string
Liste les éléments du sélecteur générique triés
saisies_picker_selected_par_objet(string $selected) : array<string|int, mixed>
Les éléments sont triés par objets puis par identifiants
Liste des objets sélectionnés
Liste des objets triés
Lister les objets qui ont une url_edit renseignée et qui sont éditables.
lister_tables_objets_edit() : array<string|int, mixed>
Liste des objets : index : nom de la table (spip_articles, spip_breves, etc.) 'type' : le type de l'objet ; 'url_edit' : l'url d'édition de l'objet ; 'texte_objets' : le nom humain de l'objet éditorial.
Afficher la chaine de langue traduite.
saisies_label(string $chaine) : string
Les liens ouvrants, c'est mal en général.
saisies_liens_ouvrants(string $texte) : string
Sauf dans un cas particulier : dans les explications dans un formulaire. En effet, si le lien n'est pas ouvrant, la personne en train de remplir un formulaire a) lis une explication b) clique sur le lien pour savoir comment remplir son formulaire c) est redirigée directement vers une page d) perd du coup ce qu'elle avait commencé remplir. Par conséquent, en terme d'accessibilité, il vaut mieux POUR LES EXPLICATIONS DE FORMULAIRE avoir des liens systématiquement ouvrant, et ce que le lien pointe en interne ou en externe (ce qui distingue du filtre |liens_ouvrants). D'où un filtre saisies_liens_ouvrants
$texte
Afficher un statut traduit
saisies_statut_titre(string $statut[, string $objet = '' ]) : string
Le statut (publie, refuse, ...)
Le type d’objet (article, rubrique, ...)
La traduction du statut, si on la trouve, sinon simplement la clé...
Convertit si nécessaire une valeur au format du picker ajax du sélecteur générique quand on sait que la valeur ne concerne qu'un seul type d'objet.
saisies_picker_preselect_objet(array<string|int, mixed>|string|int $valeur, string $objet) : array<string|int, mixed>
Fait en quelque sorte l'inverse de picker_selected(). Cela évite d'avoir à modifier le charger des formulaires quand on traite des cas simples : juste un plusieurs ids d'un seul type d'objet.
array('article|1', 'article|2')
Tableau au format du sélecteur générique
Function inverse de la fonction du core `utf8_noplanes()` Trouve les entités HTML numérique des hautes "planes" et les remets en Unicode
saisies_utf8_restaurer_planes(string|null $x) : string
Ajoute les scripts JS et CSS de saisies dans l'espace privé
saisies_header_prive(string $flux) : string
Insérer automatiquement les scripts JS et CSS de saisies dans toutes les pages de l'espace public
saisies_insert_head(array<string|int, mixed> $flux) : array<string|int, mixed>
$flux modifié
Ajoute les scripts JS et CSS de saisies dans l'espace public
saisies_affichage_final(string $flux) : string
Ajoute également de quoi gérer le datepicker de la saisie date si celle-ci est utilisée dans la page.
Génère le contenu du head pour les saisies (css et js)
saisies_generer_head([string $html_content = '' ][, mixed $tester_saisies = false ]) : string
le contenu html où l'on teste la présence de saisies
Déclarer automatiquement les champs d'un formulaire CVT qui déclare des saisies
saisies_formulaire_charger(array<string|int, mixed> $flux) : array<string|int, mixed>
Recherche une fonction formulaires_XX_saisies_dist
et l'utilise si elle
est présente. Cette fonction doit retourner une liste de saisies dont on se
sert alors pour calculer les champs utilisés dans le formulaire.
Envoie sous forme d'hidden chiffré les anciennes valeurs lorsqu'une saisie à des choix dépubliés uniquement si on vérifie les valeurs acceptables
saisies_formulaire_charger_generer_hidden_ancienne_valeur_depubliee(array<string|int, mixed> $flux) : string
, le flux du pipeline saisies_charger()
Pre remplir les options 'defaut' des saisies depuis `lire_config()`
saisies_preremplir_defaut_depuis_config(array<string|int, mixed> $saisies, string $meta_case) : array<string|int, mixed>
;
;
$saisies
Aiguiller CVT vers un squelette propre à Saisies lorsqu'on a déclaré des saisies et qu'il n'y a pas déjà un HTML
saisies_styliser(array<string|int, mixed> $flux) : array<string|int, mixed>
Dans le cadre d'un formulaire CVT demandé, si ce formulaire a déclaré des saisies, et qu'il n'y a pas de squelette spécifique pour afficher le HTML du formulaire, alors on utilise le formulaire générique intégré au plugin saisie, qui calculera le HTML à partir de la déclaration des saisies indiquées.
Ajouter les vérifications déclarées dans la fonction "saisies" du CVT
saisies_formulaire_verifier(array<string|int, mixed> $flux) : array<string|int, mixed>
Si un formulaire CVT a déclaré des saisies, on utilise sa déclaration pour effectuer les vérifications du formulaire.
'data' Liste des erreurs du formulaire 'args' Arguments du pipeline
$flux ajusté
Modifie si besoin le $flux de vérification pour activer la prévisualisation au dessus
saisies_verifier_previsualisation_au_dessus(array<string|int, mixed> $flux, array<string|int, mixed> $saisies, string|null $valider_previsu) : array<string|int, mixed>
comme pour le pipeline
tableau de saisies
, le résultat de _request('valider_previsu')
$flux idem
Ajouter les vérifications déclarées dans la fonction "saisies" du CVT mais pour les étapes
saisies_formulaire_verifier_etape(array<string|int, mixed> $flux) : array<string|int, mixed>
Liste des erreurs du formulaire
iste des erreurs
1. À la reception d'un formulaire, rechercher les saisie qui autorise choix_alternatif, et mettre si besoin la valeur envoyé en choix alternatif comme valeur principal.
saisies_formulaire_receptionner(array<string|int, mixed> $flux) : array<string|int, mixed>
;
$flux;
Regarde les saisies qui ont un choix alternatif, et met dans _request() la valeur de ce choix alternatif si jamais ce n'est pas une saisie tabulaire
saisies_formulaire_receptionner_deplacer_choix_alternatif(array<string|int, mixed> $flux, array<string|int, mixed> $saisies) : void
le flux, a priori ne sert pas, mais permet d'avoir une signature similaire à d'autres sous fonction du pipeline _receptionner
Rétablir si besoin les anciennes clés secretes à réceptions
saisies_formulaire_receptionner_retablir_cle_secrete(array<string|int, mixed> $flux, array<string|int, mixed> $saisies) : mixed
description d'un $flux de receptions
description des saisies
Retourne une chaine renvoyant les functions js de masquage/affiche
afficher_si_definir_fonctions() : mixed
Bien que proposé avec le plugin verifier la vérification `fichiers` n'a de sens que si la saisie `fichiers` du plugin CVT-Upload est disponible.
saisies_saisies_verifier_lister_disponibles(array<string|int, mixed> $flux) : array<string|int, mixed>
$flux
Bien que livrée avec saisies, la saisie `mot` ne doit pas être proposée si les mots ne sont pas activés On se branche sur le pipeline pour que la fonction originelle soit la plus simple possible, qu'elle n'ait pas à se préoccuper de l'état de la config SPIP
saisies_saisies_lister_disponibles(array<string|int, mixed> $saisies) : array<string|int, mixed>
les saisies
$saisies les saisies sans la saisies mot
Appliquer le chiffrement des name de nospam sur les `afficher_si`
saisies_formulaire_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
Prendre les anciennes valeurs envoyées par _request et les mettres en contexte globale après les avoirs décodées
saisies_formulaire_receptionner_set_request_anciennes_valeurs(string $flux) : void
verifier_afficher_si_dist(string $valeur) : string
La valeur à vérifier.
Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
Vérifier qu'une saisie est sous forme d'une chaine transformable en tableau de data C'est-à-dire de la forme cle|valeur Et ce en autorisant les sous-groupes (sauf si demande contraire) Mais en refusant les clés construite automatiquement pour des lignes sans pipe.
verifier_saisies_option_data_dist(string $valeur[, mixed $options = [] ]) : string
On en profite pour vérifier qu'il n'y pas de clé en double. De plus les trim() pertubent les choses.
La valeur à vérifier.
interdire_sous_groupes => True|False verifier_cles => array décrivant une vérification à effectuer
Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
verifier_valeurs_acceptables_dist(string $valeur, array<string|int, mixed> $options) : string
La valeur à vérifier.
les options de vérification
Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.