Documentation du code de SPIP et de ses plugins

Saisies pour formulaires

Documentation

Packages

SPIP
Application

Interfaces, Classes, Traits and Enums

Pile
Conteneur pour modifier les arguments d'une balise SPIP (de classe Champ) à compiler

Table of Contents

_SAISIES_AFFICHER_SI_JS_HIDE  = 'slideUp(800)'
_SAISIES_AFFICHER_SI_JS_SHOW  = 'slideDown(800)'
action_deplacer_saisie_dist()  : void
Action de déplacement de saisies dans le constructeur de formulaires
balise_CONFIGURER_SAISIE_dist()  : Champ
Compile la balise `#CONFIGURER_SAISIE`
balise_GENERER_SAISIES_dist()  : Champ
Compile la balise `#GENERER_SAISIES` qui retourne le code HTML des saisies de formulaire, à partir du tableau des saisies transmises
balise_SAISIE_dist()  : Champ
Compile la balise `#SAISIE` qui retourne le code HTML de la saisie de formulaire indiquée.
balise_VOIR_SAISIE_dist()  : Champ
Compile la balise `#VOIR_SAISIE` qui retourne le code HTML de la vue d'une saisie indiquée
balise_VOIR_SAISIES_dist()  : Champ
Compile la balise `#VOIR_SAISIES` qui retourne le code HTML des vues de formulaire, à partir du tableau des saisies transmises
champs_extras_calculer_balise_LISTER_VALEURS_choix_grille()  : array<string|int, mixed>|string
Déclaration de la balise LISTER_VALEURS pour la saisie `choix_grille`
champs_extras_serialiser_choix_grille()  : string
Sérialise les réponses à un champ extra de type `choix_grille` pour encodage en base.
formulaires_configurer_saisies_saisies_dist()  : array<string|int, mixed>
Saisies du formulaire de configuration de saisies
formulaires_construire_formulaire_charger()  : array<string|int, mixed>
Formulaire permettant de construire un formulaire ! En agençant des champs Chargement.
formulaires_construire_formulaire_verifier()  : mixed
formulaires_construire_formulaire_traiter()  : mixed
construire_formulaire_transformer_nom()  : mixed
construire_formulaire_transformer_afficher_si()  : mixed
construire_formulaire_generer_saisie_configurable()  : string
Préparer une saisie pour la transformer en truc configurable
saisie_option_contenu_vide()  : bool
Callback d'array_filter() Permet de retourner tout ce qui n'est pas un contenu vide.
saisies_groupe_inserer()  : mixed
formulaires_saisies_cvt_saisies_dist()  : mixed
formulaires_saisies_cvt_charger()  : mixed
_T_ou_typo()  : 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
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_parser_condition_afficher_si()  : array<string|int, mixed>
Reçoit une condition la parse pour trouver champs/opérateurs/valeurs etc.
saisies_afficher_si_filtrer_parse_condition()  : array<string|int, mixed>
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_evaluer_plugin()  : bool
Retourne le résultat de l'évaluation d'un plugin actif
saisies_tester_condition_afficher_si()  : bool
Teste une condition d'afficher_si
saisies_tester_condition_afficher_si_string()  : bool
Teste un condition d'afficher_si lorsque la valeur envoyée par le formulaire est une chaîne
saisies_tester_condition_afficher_si_array()  : bool
Teste un condition d'afficher_si lorsque la valeur postée est un tableau
saisies_afficher_si_get_valeur_config()  : string
Retourne la valeur d'une config, si nécessaire
saisies_afficher_si_secure()  : bool
Vérifie qu'une condition est sécurisée IE : ne permet pas d'executer n'importe quel code arbitraire.
saisies_afficher_si_verifier_syntaxe()  : bool
Vérifie qu'une condition respecte la syntaxe formelle
afficher_si_parser_valeur_MATCH()  : mixed
Décompose une chaine '/regex/modificateur'
saisies_verifier_coherence_afficher_si()  : string
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 inexistans
saisies_afficher_si_js()  : string
Transforme une condition afficher_si en condition js
saisies_afficher_si_js_est_statique()  : bool
Vérifier qu'une test JS d'afficher si est statique, c'est à dire qu'il ne dépend d'aucune saisie de l'étape en court.
saisies_verifier_afficher_si()  : array<string|int, mixed>
Traitement des saisies ayant l'option `afficher_si`.
saisies_afficher_si_masquees_set_request_empty_string()  : mixed
Cette fonction doit toujours être appelé après le passage dans `saisies_verifier()` 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`
saisies_set_request_recursivement()  : mixed
Pose un set_request sur une saisie et toute ses sous-saisies.
saisies_afficher_si_get_valeur_champ()  : la
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 sinon en _request() ou en $env["valeurs"]
saisies_transformer_condition_afficher_si()  : string
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_evaluer_afficher_si()  : bool
Evalue un afficher_si
saisies_afficher_si_liste_masquees()  : array<string|int, mixed>|null
Liste des saisies masquées par afficher_si dans le hit courant
saisies_generer_aide()  : string
Génère une page d'aide listant toutes les saisies et leurs options
saisies_aplatir_chaine()  : mixed
Aplatit une description chaînée, en supprimant les sous-groupes.
saisies_chaine2tableau()  : array<string|int, mixed>
Transforme une chaine en tableau avec comme principe :
saisies_tableau2chaine()  : string
Transforme un tableau en chaine de caractères avec comme principe :
saisies_valeur2tableau()  : array<string|int, mixed>
Transforme une valeur en tableau d'élements si ce n'est pas déjà le cas
saisies_trouver_choix_alternatif()  : string
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_aplatir_tableau()  : array<string|int, mixed>
Aplatit une description tabulaire en supprimant les sous-groupes.
saisies_trouver_data()  : array<string|int, mixed>
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_normaliser_disable_choix()  : array<string|int, mixed>
Prend une option disable_choix 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_chercher_formulaire()  : array<string|int, mixed>
Cherche la description des saisies d'un formulaire CVT dont on donne le nom
saisies_generer_nom()  : string
Génère un nom unique pour un champ d'un formulaire donné
saisies_determiner_avance_rapide()  : int
Détermine si peut faire une avance rapide en sautant des étapes qui sont "masquées" par afficher_si
saisies_determiner_recul_rapide()  : int
Détermine si peut faire un recul rapide en sautant des étapes qui sont "masquées" par afficher_si
saisies_determiner_deplacement_rapide()  : int
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()`
saisie_identifier()  : array<string|int, mixed>
Crée un identifiant Unique pour la saisie donnee si elle n'en a pas (et pour ses sous saisies éventuels)
saisies_identifier()  : array<string|int, mixed>
Crée un identifiant Unique pour toutes les saisies donnees qui n'en ont pas
saisies_supprimer_identifiants()  : array<string|int, mixed>
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_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_saisie_est_tabulaire()  : return
La saisie renvoie t-elle un tableau? note: on teste saisie par saisie, et non pas type de saisie par type de saisie, car certaine type (`selection` par ex.) peut, en fonction des options, être tabulaire ou pas.
saisies_saisie_est_fichier()  : mixed
La saisie remplie-t-elle `$_FILES` ? note: on teste saisie par saisie, et non pas type de saisie par type de saisie, car certaine type (`input` par ex.) peut, en fonction des options, être tabulaire ou pas.
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_verifier_gel_saisie()  : bool
Indique si une saisie à sa valeur gelée - soit par option disabled avec envoi cachée - soit par option readonly
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 regroupants en catégorie
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
saisies_supprimer()  : array<string|int, mixed>
Supprimer une saisie dont on donne l'identifiant, le nom ou le chemin.
saisies_inserer()  : array<string|int, mixed>
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_avant()  : array<string|int, mixed>
Insère une saisie avant une autre saisie.
saisies_inserer_apres()  : array<string|int, mixed>
Insère une saisie après une autre saisie.
saisies_inserer_selon_chemin()  : array<string|int, mixed>
Insère une saisie à une position donnée, en lui passant un chemin.
saisies_dupliquer()  : array<string|int, mixed>
Duplique une saisie (ou groupe de saisies) en placant la copie à la suite de la saisie d'origine.
saisies_deplacer()  : array<string|int, mixed>
Déplace une saisie existante autre part.
saisies_deplacer_avant()  : array<string|int, mixed>
Déplacer une saisie existante avant une autre
saisies_deplacer_apres()  : array<string|int, mixed>
Déplacer une saisie existante après une autre
saisies_modifier()  : Retourne
Modifie une saisie.
saisies_transformer_noms()  : array<string|int, mixed>
Transforme tous les noms du formulaire avec un preg_replace.
saisies_transformer_option()  : array<string|int, mixed>
Transforme toutes les options textuelles d'un certain nom, avec un preg_replace.
saisies_mapper_option()  : array<string|int, mixed>
Modifie toutes les options d'un certain nom, avec une fonction de rappel.
saisies_supprimer_option()  : array<string|int, mixed>
Supprime toutes les options textuelles d'un certain nom, avec un preg_replace.
saisies_transformer_noms_auto()  : array<string|int, mixed>
Transforme les noms d'une liste de saisies pour qu'ils soient uniques dans le formulaire donné.
saisies_inserer_html()  : array<string|int, mixed>
Insère du HTML au début ou à la fin d'une saisie.
saisies_fieldsets_en_onglets()  : array<string|int, mixed>
Ajoute l'option onglet aux fieldset de premier niveau dans un tableau de $saisie Ajoute également un identifiant unique, éventuellement préfixé
saisies_migrer_afficher_si_remplissage()  : array<string|int, mixed>
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
saisie_nom2classe()  : string
Passer un nom en une valeur compatible avec une classe css
saisie_type2classe()  : string
Ajouter une ou des classes sur la saisie en fonction du type
saisie_nom2name()  : string
Passer un nom en une valeur compatible avec un `name` de formulaire
saisie_name2nom()  : string
Passer un `name` en un format de nom compris de saisies
saisies_cles_nom2name()  : array<string|int, mixed>
Appliquer `saisie_nom2name()` sur les clés d'un tableau utilisé pour gérer les erreurs
saisies_request()  : string|array<string|int, mixed>
Trouve le résultat d'une saisie (_request()) en tenant compte du fait que la saisie peut être décrit sous forme de sous entrées d'un tableau - soit `toto[truc][bidule]` - soit `toto/truc/bidule`
saisies_request_from_FILES()  : array<string|int, mixed>|null
Trouve le sous tableau de $_FILES correspondant à champ, en prenant en compte CVT-Upload
saisies_request_property_from_FILES()  : string|array<string|int, mixed>
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_set_request()  : void
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_liste_set_request()  : mixed
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_get_valeur_saisie()  : string|array<string|int, mixed>
Chercher la valeur d'une saisie, en tenant compte du fait que potentiellement c'est une saisies fichiers
saisies_verifier()  : array<string|int, mixed>
Vérifier tout un formulaire tel que décrit avec les Saisies
saisies_verifier_valeurs_acceptables()  : array<string|int, mixed>
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.
construire_configuration_saisie()  : mixed
auteurs_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
case_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
checkbox_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
date_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
email_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
hidden_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
input_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
oui_non_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
radio_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
selection_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
selection_multiple_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
textarea_valeurs_acceptables()  : bool
Vérifie que la valeur postée correspond aux valeurs proposées lors de la config de valeur
saisies_upgrade()  : void
Installation/maj des config de saisies
saisies_corriger_assests()  : mixed
Corrige une honteuse coquille
saisies_vider_tables()  : mixed
saisies_afficher_si_js_defaut()  : mixed
Generation du js d'afficher_si par défaut
saisie_balise_structure_formulaire()  : string
Retourne une balise dev. Maintenu pour compatibilité historique, ne plus utiliser.
balise_DIV_dist()  : Pile
Compile la balise `DIV` qui retourne simplement le texte `div`
saisie_traitement_vue()  : string
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
balise_GLOBALS_dist()  : Champ
Compile la balise `#GLOBALS{xxx}` qui retourne la valeur d'une vilaine variable globale de même nom si elle existe
picker_selected_par_objet()  : array<string|int, mixed>
Liste les éléments du sélecteur générique triés
lister_tables_objets_edit()  : array<string|int, mixed>
Lister les objets qui ont une url_edit renseignée et qui sont éditables.
saisies_label()  : string
Afficher la chaine de langue traduite.
saisies_liens_ouvrants()  : string
Les liens ouvrants, c'est mal en général.
saisies_statut_titre()  : string
Afficher un statut traduit
saisies_picker_preselect_objet()  : array<string|int, mixed>
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_utf8_restaurer_planes()  : string
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_header_prive()  : string
Ajoute les scripts JS et CSS de saisies dans l'espace privé
saisies_insert_head()  : array<string|int, mixed>
Insérer automatiquement les scripts JS et CSS de saisies dans toutes les pages de l'espace public
saisies_affichage_final()  : string
Ajoute les scripts JS et CSS de saisies dans l'espace public
saisies_generer_head()  : string
Génère le contenu du head pour les saisies (css et js)
saisies_formulaire_charger()  : array<string|int, mixed>
Déclarer automatiquement les champs d'un formulaire CVT qui déclare des saisies
saisies_preremplir_defaut_depuis_config()  : array<string|int, mixed>
Pre remplir les options 'defaut' des saisies depuis `lire_config()`
saisies_styliser()  : array<string|int, mixed>
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_formulaire_verifier()  : array<string|int, mixed>
Ajouter les vérifications déclarées dans la fonction "saisies" du CVT
saisies_formulaire_verifier_etape()  : array<string|int, mixed>
Ajouter les vérifications déclarées dans la fonction "saisies" du CVT mais pour les étapes
saisies_formulaire_receptionner()  : array<string|int, mixed>
À la réception d'un formulaire de config rechercher les input avec l'option cle_secrete.
afficher_si_definir_fonctions()  : mixed
Retourne une chaine renvoyant les functions js de masquage/affiche
verifier_afficher_si_dist()  : string
verifier_saisies_option_data_dist()  : string
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_valeurs_acceptables_dist()  : string

Constants

Functions

action_deplacer_saisie_dist()

Action de déplacement de saisies dans le constructeur de formulaires

action_deplacer_saisie_dist() : void
Return values
void

balise_GENERER_SAISIES_dist()

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}
Parameters
$p : Champ

Pile au niveau de la balise

Tags
syntaxe

#GENERER_SAISIES{#TABLEAU_DE_SAISIES}

uses
Pile::recuperer_et_supprimer_argument_balise()
uses
Pile::creer_et_ajouter_argument_balise()
see
balise_INCLURE_dist()
Return values
Champ

Pile complété du code à générer

balise_SAISIE_dist()

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,...}

Parameters
$p : Champ
Tags
syntaxe

#SAISIE{type,nom[,option=xx,...]}

uses
Pile::recuperer_et_supprimer_argument_balise()
uses
Pile::creer_balise()
uses
Pile::creer_et_ajouter_argument_balise()
see
balise_INCLURE_dist()
Return values
Champ

balise_VOIR_SAISIE_dist()

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

Parameters
$p : Champ
Tags
syntaxe

#VOIR_SAISIE{type,nom[,option=valeur,...]}

uses
Pile::recuperer_et_supprimer_argument_balise()
uses
Pile::creer_et_ajouter_argument_balise()
uses
Pile::creer_balise()
see
balise_INCLURE_dist()
Return values
Champ

balise_VOIR_SAISIES_dist()

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 :

  • une liste de descriptions de saisies dont on veut générer le HTML affichant les vues du formulaires
  • un liste des valeurs Cette balise est un raccourcis :
  • #VOIR_SAISIES{#TABLEAU_DE_SAISIES} est équivalent à
  • #INCLURE{fond=inclure/voir_saisies,env,saisies=#TABLEAU_DE_SAISIES,valeurs=#TABLEAU_DE_VALEURS}
Parameters
$p : Champ

Pile au niveau de la balise

Tags
syntaxe

#VOIR_SAISIES{#TABLEAU_DE_SAISIES}

uses
Pile::recuperer_et_supprimer_argument_balise()
uses
Pile::creer_et_ajouter_argument_balise()
see
balise_INCLURE_dist()
Return values
Champ

Pile complété du code à générer

champs_extras_calculer_balise_LISTER_VALEURS_choix_grille()

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
Parameters
$objet : string

Type d'objet

$colonne : string

Nom de la colonne SQL

$cles : string

Valeurs enregistrées pour ce champ dans la bdd pour l'objet en cours

Return values
array<string|int, mixed>|string

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'

champs_extras_serialiser_choix_grille()

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
Parameters
$extra : array<string|int, mixed>

La valeur reçue en POST

$saisie : array<string|int, mixed>

La description de la saisie

Return values
string

Forme serialisé, en l'occurence avec saisies_tableau2chaine

formulaires_configurer_saisies_saisies_dist()

Saisies du formulaire de configuration de saisies

formulaires_configurer_saisies_saisies_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_construire_formulaire_charger()

Formulaire permettant de construire un formulaire ! En agençant des champs Chargement.

formulaires_construire_formulaire_charger(string $identifiant[, mixed $formulaire_initial = array() ][, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
$identifiant : string

identifiant unique du formulaire

$formulaire_initial : mixed = array()
$options : array<string|int, mixed> = array()

tableau d'options

  • array options_globales : proposer des options globales pour le formulaire, liste de ces options
  • array saisies_exclues : liste des saisies à ne pas proposer (= à exclure du choix)
  • bool uniquement_sql : ne proposer que les saisies qui permettent de remplir un champ sql
Return values
array<string|int, mixed>

$contexte

formulaires_construire_formulaire_verifier()

formulaires_construire_formulaire_verifier(mixed $identifiant[, mixed $formulaire_initial = array() ][, mixed $options = array() ]) : mixed
Parameters
$identifiant : mixed
$formulaire_initial : mixed = array()
$options : mixed = array()
Return values
mixed

formulaires_construire_formulaire_traiter()

formulaires_construire_formulaire_traiter(mixed $identifiant[, mixed $formulaire_initial = array() ][, mixed $options = array() ]) : mixed
Parameters
$identifiant : mixed
$formulaire_initial : mixed = array()
$options : mixed = array()
Return values
mixed

construire_formulaire_transformer_nom()

construire_formulaire_transformer_nom(mixed &$valeur, mixed $cle, mixed $transformation) : mixed
Parameters
$valeur : mixed
$cle : mixed
$transformation : mixed
Return values
mixed

construire_formulaire_transformer_afficher_si()

construire_formulaire_transformer_afficher_si(mixed &$valeur, mixed $cle, mixed $transformation) : mixed
Parameters
$valeur : mixed
$cle : mixed
$transformation : mixed
Return values
mixed

construire_formulaire_generer_saisie_configurable()

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
Parameters
$saisie : array<string|int, mixed>

description de la saisie

$env : array<string|int, mixed>

environnement d'appel

Return values
string

fond du formulaire

saisie_option_contenu_vide()

Callback d'array_filter() Permet de retourner tout ce qui n'est pas un contenu vide.

saisie_option_contenu_vide( $var) : bool

La valeur '0' est par contre retournée.

Parameters
$var :

La variable a tester

Return values
bool

L'accepte-t-on ?

saisies_groupe_inserer()

saisies_groupe_inserer(mixed $formulaire_actuel, mixed $saisie) : mixed
Parameters
$formulaire_actuel : mixed
$saisie : mixed
Return values
mixed

formulaires_saisies_cvt_saisies_dist()

formulaires_saisies_cvt_saisies_dist() : mixed
Return values
mixed

formulaires_saisies_cvt_charger()

formulaires_saisies_cvt_charger() : mixed
Return values
mixed

_T_ou_typo()

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
Parameters
$valeur : mixed

Une valeur à tester. Si c'est un tableau, la fonction s'appliquera récursivement dessus.

$mode_typo : string = 'toujours'

Le mode d'application de la fonction typo(), avec trois valeurs possibles "toujours", "jamais" ou "multi".

Return values
mixed

Retourne la valeur éventuellement modifiée.

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 s'appuie 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 = array() ]) : 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> = array()

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() ][, array<string|int, mixed> $env_obligatoire = array() ]) : string
Parameters
$saisie : array<string|int, mixed>

Tableau de description d'une saisie

$env : array<string|int, mixed> = array()

L'environnement, contenant normalement la réponse à la saisie

$env_obligatoire : array<string|int, mixed> = array()

Ce qui doit toujours être passé à l'environnement

Tags
see
saisies_generer_html()
Return values
string

Code HTML de la vue de la saisie

saisies_parser_condition_afficher_si()

Reçoit une condition la parse pour trouver champs/opérateurs/valeurs etc.

saisies_parser_condition_afficher_si(string $condition[, mixed $no_arobase = null ]) : array<string|int, mixed>
Parameters
$condition : string
$no_arobase : mixed = null
Return values
array<string|int, mixed>

tableau d'analyse (resultat d'un preg_match_all) montrant sous condition par sous condition l'analyse en champ/opérateur/valeur etc.

saisies_afficher_si_filtrer_parse_condition()

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'aurai pas besoin de cette fonction Note : on garde les fonctions entrées vides, car parfois besoin de distinguer vide de null

Parameters
$parse : array<string|int, mixed>
Return values
array<string|int, mixed>

$parse

saisies_afficher_si_evaluer_plugin()

Retourne le résultat de l'évaluation d'un plugin actif

saisies_afficher_si_evaluer_plugin(string $champ[, string $negation = '' ]) : bool
Parameters
$champ : string

(sans les @@)

$negation : string = ''

! si on doit nier

Return values
bool

'' ('' si jamais on ne teste pas un plugin)

saisies_tester_condition_afficher_si()

Teste une condition d'afficher_si

saisies_tester_condition_afficher_si(string|array<string|int, mixed> $valeur_champ, string $total[, string $operateur = '' ][, string $valeur = '' ][, string $negation = '' ]) : bool
Parameters
$valeur_champ : string|array<string|int, mixed>

la valeur du champ à tester. Cela peut être :

  • un string
  • un tableau
  • un tableau sérializé
$total : string

TOTAL si on demande de faire le décompte dans un tableau

$operateur : string = ''

: l'opérateur

$valeur : string = ''

la valeur à tester

$negation : string = ''

y-a-t-il un négation avant le test ? '!' si oui

Return values
bool

false / true selon la condition

saisies_tester_condition_afficher_si_string()

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, string $operateur, string|int $valeur) : bool
Parameters
$valeur_champ : string

la valeur du champ à tester.

$operateur : string

: l'opérateur:

$valeur : string|int

la valeur à tester.

Return values
bool

false / true selon la condition

saisies_tester_condition_afficher_si_array()

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, mixed $total, string $operateur, string $valeur) : bool
Parameters
$valeur_champ : array<string|int, mixed>

la valeur du champ à tester.

$total : mixed
$operateur : string

: l'opérateur:

$valeur : string

la valeur à tester pour un IN. Par exemple "23" ou encore "23,25"

Return values
bool

false / true selon la condition

saisies_afficher_si_get_valeur_config()

Retourne la valeur d'une config, si nécessaire

saisies_afficher_si_get_valeur_config(string $champ) : string
Parameters
$champ : string

le "champ" a tester : config:xxx ou un vrai champ

Return values
string

saisies_afficher_si_secure()

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 = array() ]) : bool
Parameters
$condition : string
$tests : array<string|int, mixed> = array()

tableau des tests parsés

Return values
bool

true si secure / false sinon

saisies_afficher_si_verifier_syntaxe()

Vérifie qu'une condition respecte la syntaxe formelle

saisies_afficher_si_verifier_syntaxe(string $condition[, array<string|int, mixed> $tests = array() ]) : bool
Parameters
$condition : string
$tests : array<string|int, mixed> = array()

liste des tests simples

Return values
bool

afficher_si_parser_valeur_MATCH()

Décompose une chaine '/regex/modificateur'

afficher_si_parser_valeur_MATCH(string $valeur) : mixed
Parameters
$valeur : string
Return values
mixed

saisies_verifier_coherence_afficher_si()

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 inexistans

saisies_verifier_coherence_afficher_si(array<string|int, mixed> $saisies) : string
Parameters
$saisies : array<string|int, mixed>
Return values
string

erreurs

saisies_afficher_si_js()

Transforme une condition afficher_si en condition js

saisies_afficher_si_js(string $condition[, array<string|int, mixed> $saisies_par_etapes = array() ]) : string
Parameters
$condition : string
$saisies_par_etapes : array<string|int, mixed> = array()

les saisies du même formulaire, regroupées par etapes. Nécessaire pour savoir quel type de test js on met.

Return values
string

saisies_afficher_si_js_est_statique()

Vérifier qu'une test JS d'afficher si est statique, c'est à dire qu'il ne dépend d'aucune saisie de l'étape en court.

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

Parameters
$test : mixed
Return values
bool

saisies_verifier_afficher_si()

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() ]) : array<string|int, mixed>

Lorsque qu'on affiche les saisies avec #VOIR_SAISIES, ou lorsqu'on les vérifie avec saisies_verifier(). Si les conditions d'affichage d'une saisie n'est pas remplie :

  • On la retire du tableau de saisies, SAUF SI l'une des trois conditions suivantes est remplie:
    • l'option de la saisie individuelle afficher_si_avec_post est activée;
    • l'option globale afficher_si_avec_post est activée;
    • l'option de la saisie individuelle afficher_si_remplissage_uniquement est activée. Sur le détail des usages des différentes options, voir https://contrib.spip.net/5081#Options-supplementaires
Parameters
$saisies : array<string|int, mixed>

Tableau de descriptions de saisies

$env : array<string|int, mixed>|null = null

Tableau d'environnement transmis dans inclure/voir_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).

$saisies_toutes_par_nom : array<string|int, mixed> = array()

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

Return values
array<string|int, mixed>

Tableau de descriptions de saisies

saisies_afficher_si_masquees_set_request_empty_string()

Cette fonction doit toujours être appelé après le passage dans `saisies_verifier()` 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`

saisies_afficher_si_masquees_set_request_empty_string(mixed $saisies[, mixed $valeurs = null ]) : mixed
Parameters
$saisies : mixed
$valeurs : mixed = null
Return values
mixed

saisies_set_request_recursivement()

Pose un set_request sur une saisie et toute ses sous-saisies.

saisies_set_request_recursivement(array<string|int, mixed> $saisie[, null|str|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.

Parameters
$saisie : array<string|int, mixed>
$val : null|str|array<string|int, mixed> = ''

(defaut '')

$valeurs : array<string|int, mixed> = null

Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST

Return values
mixed

saisies_afficher_si_get_valeur_champ()

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 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) : la
Parameters
$champ : string
$env : null|array<string|int, mixed>
$saisies_par_nom : array<string|int, mixed>

Les saisies déjà classées par nom de champ

Return values
la

valeur du champ ou de la config

saisies_transformer_condition_afficher_si()

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 = array() ][, string|null $no_arobase = null ]) : string
Parameters
$condition : string
$env : array<string|int, mixed>|null = null

Tableau d'environnement transmis dans inclure/voir_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).

$saisies_par_nom : array<string|int, mixed> = array()

Les saisies déjà classées par nom de champ

$no_arobase : string|null = null

une valeur à tester là où il devrait y avoir un @@

Return values
string

$condition

saisies_evaluer_afficher_si()

Evalue un afficher_si

saisies_evaluer_afficher_si(string $condition[, array<string|int, mixed>|null $env = null ][, array<string|int, mixed> $saisies_par_nom = array() ][, string|null $no_arobase = null ]) : bool
Parameters
$condition : string
$env : array<string|int, mixed>|null = null

Tableau d'environnement transmis dans inclure/voir_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).

$saisies_par_nom : array<string|int, mixed> = array()

Les saisies déjà classées par nom de champ

$no_arobase : string|null = null

une valeur à tester là où il devrait y avoir un @@

Return values
bool

le résultat du test

saisies_afficher_si_liste_masquees()

Liste des saisies masquées par afficher_si dans le hit courant

saisies_afficher_si_liste_masquees([str $action = 'get' ][, array<string|int, mixed> $saisie = '' ]) : array<string|int, mixed>|null
Parameters
$action : str = 'get'

('set'|'get'), defaut 'get';

$saisie : array<string|int, mixed> = ''

complète

Return values
array<string|int, mixed>|null

saisies_generer_aide()

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.

Return values
string

Code HTML

saisies_aplatir_chaine()

Aplatit une description chaînée, en supprimant les sous-groupes.

saisies_aplatir_chaine(string $chaine) : mixed
Parameters
$chaine : string

La chaîne à aplatir

Return values
mixed

saisies_chaine2tableau()

Transforme une chaine en tableau avec comme principe :

saisies_chaine2tableau(string $chaine[, string $separateur = " " ]) : array<string|int, mixed>
  • une ligne devient une case
  • si la ligne est de la forme truc|bidule alors truc est la clé et bidule la valeur
  • si la ligne commence par * alors on commence un sous-tableau
  • si la ligne est égale à /*, alors on finit le sous-tableau
Parameters
$chaine : string

Une chaine à transformer

$separateur : string = " "

Séparateur utilisé

Return values
array<string|int, mixed>

Retourne un tableau PHP

saisies_tableau2chaine()

Transforme un tableau en chaine de caractères avec comme principe :

saisies_tableau2chaine(array<string|int, mixed> $tableau) : string
  • une case devient une ligne de la chaine
  • chaque ligne est générée avec la forme cle|valeur
  • si une entrée du tableau est elle même un tableau, on met une ligne de la forme *clef
  • pour marquer que l'on quitte un sous-tableau, on met une ligne commencant par /*, sauf si on bascule dans un autre sous-tableau.
Parameters
$tableau : array<string|int, mixed>

Tableau à transformer

Return values
string

Texte représentant les données du tableau

saisies_valeur2tableau()

Transforme une valeur en tableau d'élements si ce n'est pas déjà le cas

saisies_valeur2tableau(mixed $valeur[, mixed $data = array() ]) : array<string|int, mixed>
Parameters
$valeur : mixed
$data : mixed = array()
Return values
array<string|int, mixed>

Tableau de valeurs

saisies_trouver_choix_alternatif()

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
Parameters
$data : array<string|int, mixed>
$valeur : array<string|int, mixed>
Return values
string

choix_alternatif

saisies_aplatir_tableau()

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

Parameters
$tab : array<string|int, mixed>

Le tableau à aplatir

$masquer_sous_groupe : bool = false

mettre à true pour ne pas montrer le sous-groupe dans les label humain

Return values
array<string|int, mixed>

saisies_trouver_data()

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>
Parameters
$description : array<string|int, mixed>

description de la saisie

$disable_choix : mixed = false
Tags
bool

$disable_choix : si true, supprime les valeurs contenu dans l'option disable_choix des data

Return values
array<string|int, mixed>

data

saisies_normaliser_disable_choix()

Prend une option disable_choix 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_disable_choix(array<string|int, mixed>|string $disable) : array<string|int, mixed>
Parameters
$disable : array<string|int, mixed>|string
Return values
array<string|int, mixed>

saisies_chercher_formulaire()

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>
Parameters
$form : string

Nom du formulaire dont on cherche les saisies

$args : array<string|int, mixed>

Tableau d'arguments du formulaire

$je_suis_poste : mixed = false
Return values
array<string|int, mixed>

Retourne les saisies du formulaire sinon false

saisies_generer_nom()

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
Parameters
$formulaire : array<string|int, mixed>

Le formulaire à analyser

$type_saisie : string

Le type de champ dont on veut un identifiant

Return values
string

Un nom unique par rapport aux autres champs du formulaire

saisies_determiner_avance_rapide()

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
Parameters
$saisies : array<string|int, mixed>

le tableau d'ensemble des saisies

$etape : int

l'étape à partir de laquelle on commence à tester les étapes suivantes

Return values
int

l'étape où avancer

saisies_determiner_recul_rapide()

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
Parameters
$saisies : array<string|int, mixed>

le tableau d'ensemble des saisies

$etape : int

l'étape à partir de laquelle on commence à tester les étapes suivantes

Return values
int

l'étape où avancer

saisies_determiner_deplacement_rapide()

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
Parameters
$saisies : array<string|int, mixed>

le tableau d'ensemble des saisies

$etape : int

l'étape à partir de laquelle on commence à tester les étapes suivantes

$sens : int

1 (avance) ou -1 (recule)

Return values
int

l'étape où avancer

saisie_identifier()

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>
Parameters
$saisie : array<string|int, mixed>

Tableau d'une saisie

$regenerer : bool = false

Régénère un nouvel identifiant pour la saisie ?

Return values
array<string|int, mixed>

Tableau de la saisie complété de l'identifiant

saisies_identifier()

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>
Parameters
$saisies : array<string|int, mixed>

Tableau de saisies

$regenerer : bool = false

Régénère un nouvel identifiant pour toutes les saisies ?

Return values
array<string|int, mixed>

Tableau de saisies complété des identifiants

saisies_supprimer_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>
Parameters
$saisies : mixed
Return values
array<string|int, mixed>

Tableau de la saisie sans les identifiant

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
example

$saisies_date = saisies_lister_avec_type($saisies, 'date')

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.

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>|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

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
see
saisies_comparer()
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_saisie_est_tabulaire()

La saisie renvoie t-elle un tableau? note: on teste saisie par saisie, et non pas type de saisie par type de saisie, car certaine type (`selection` par ex.) peut, en fonction des options, être tabulaire ou pas.

saisies_saisie_est_tabulaire( $saisie) : return
Parameters
$saisie :
Return values
return

bool true si la saisie est tabulaire, false sinon

saisies_saisie_est_fichier()

La saisie remplie-t-elle `$_FILES` ? note: on teste saisie par saisie, et non pas type de saisie par type de saisie, car certaine type (`input` par ex.) peut, en fonction des options, être tabulaire ou pas.

saisies_saisie_est_fichier(mixed $saisie) : mixed
Parameters
$saisie : mixed
Return values
mixed

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, unknown_type $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 : unknown_type

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_verifier_gel_saisie()

Indique si une saisie à sa valeur gelée - soit par option disabled avec envoi cachée - soit par option readonly

saisies_verifier_gel_saisie(array<string|int, mixed> $description) : bool
Parameters
$description : array<string|int, mixed>

description de la saisie

Return values
bool

true si gélée, false sinon)

saisies_lister_disponibles()

Liste toutes les saisies configurables (ayant une description).

saisies_lister_disponibles([string $saisies_repertoire = 'saisies' ][, mixed $inclure_obsoletes = true ]) : array<string|int, mixed>
Parameters
$saisies_repertoire : string = 'saisies'

le répertoire où trouver les saisies

$inclure_obsoletes : mixed = true
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 regroupants en catégorie

saisies_lister_disponibles_par_categories([array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = array()

'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 = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

voir saisies_lister_disponibles_par_categories return array

Return values
mixed

saisies_regrouper_disponibles_par_categories()

Regroupe par categories les saisies

saisies_regrouper_disponibles_par_categories([array<string|int, mixed> $saisies = array() ][, string|null $categorie_demande = null ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed> = array()
$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
Parameters
$saisie1 :
$saisie2 :
Return values
int

saisies_supprimer()

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>
Parameters
$saisies : array<string|int, mixed>

Tableau des descriptions de saisies

$id_ou_nom_ou_chemin : string|array<string|int, mixed>

L'identifiant unique ou le nom de la saisie à supprimer ou son chemin sous forme d'une liste de clés

Return values
array<string|int, mixed>

Tableau modifié décrivant les saisies

saisies_inserer()

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() ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>

Tableau des descriptions de saisies

$saisie : array<string|int, mixed>

Description de la saisie à insérer

$id_ou_nom_ou_chemin : array<string|int, mixed>|string = array()
  • Si array c'est un chemin Position complète où insérer la saisie - Si directement à la racine du tableau : array(<index_où_inserer>) - Si au sein d'un fieldset ou assimilé : array(<index_du _fieldset>, 'saisies', <index_où_inserer_au_sein_du_fieldset>)
  • Si string
    • Si entre crochets, ca veut dire qu'on insère à la fin d'un fieldset [fieldset]
    • Si entre crochets, suivis d'un entier entre crochet, on insère à une position données dans le fieldset [fieldset][0]
    • Si pas de crochet, on insère avant la saisie saisie
  • En absence, insère la saisie à la fin.
Return values
array<string|int, mixed>

Tableau des saisies complété de la saisie insérée

saisies_inserer_avant()

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>
Parameters
$saisies : array<string|int, mixed>

Tableau des descriptions de saisies

$saisie : array<string|int, mixed>

Description de la saisie à insérer

$id_ou_nom_ou_chemin : array<string|int, mixed>

identifiant ou nom ou chemin de la saisie devant laquelle inserer

Return values
array<string|int, mixed>

Tableau des saisies complété de la saisie insérée

saisies_inserer_apres()

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>
Parameters
$saisies : array<string|int, mixed>

Tableau des descriptions de saisies

$saisie : array<string|int, mixed>

Description de la saisie à insérer

$id_ou_nom_ou_chemin : array<string|int, mixed>

identifiant ou nom ou chemin de la saisie devant laquelle inserer

Return values
array<string|int, mixed>

Tableau des saisies complété de la saisie insérée

saisies_inserer_selon_chemin()

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() ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>

Tableau des descriptions de saisies

$saisie : array<string|int, mixed>

Description de la saisie à insérer

$chemin : array<string|int, mixed> = array()

Position complète où insérer la saisie

  • Si directement à la racine du tableau : array(<index_où_inserer>)
  • Si au sein d'un fieldset ou assimilé : array(<index_du _fieldset>, 'saisies', <index_où_inserer_au_sein_du_fieldset>) En absence, insère la saisie à la fin.
Return values
array<string|int, mixed>

Tableau des saisies complété de la saisie insérée

saisies_dupliquer()

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.

Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

$id_ou_nom_ou_chemin : unknown_type

L'identifiant unique ou le nom ou le chemin de la saisie a dupliquer

Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_deplacer()

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>
Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

$id_ou_nom_ou_chemin : unknown_type

L'identifiant unique ou le nom ou le chemin de la saisie à déplacer

$ou : string
  • Le nom de la saisie devant laquelle on déplacera
  • OU le nom d'un conteneur entre crochets [conteneur] (et dans ce cas on déplace à la fin de conteneur)
  • OU le nom d'un conteneur entre crochets suivi d'un identifiant numérique entre crochets [conteneur][x] (et dans ce cas on déplace à la position x au sein du conteneur)
$avant_ou_apres : string = 'avant'

(optionel) : valeur possible : 'avant' ou 'apres', pour inserer respectivent avant/après la saisie $ou

Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_deplacer_avant()

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>
Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

$id_ou_nom_ou_chemin : unknown_type

L'identifiant unique ou le nom ou le chemin de la saisie à déplacer

$ou : string

la saisie devant laquelle déplacer

Tags
use

saisie_deplacer()

Return values
array<string|int, mixed>

$string

saisies_deplacer_apres()

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>
Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

$id_ou_nom_ou_chemin : unknown_type

L'identifiant unique ou le nom ou le chemin de la saisie à déplacer

$ou : string

la saisie devant laquelle déplacer

Tags
use

saisie_deplacer()

Return values
array<string|int, mixed>

$string

saisies_modifier()

Modifie une saisie.

saisies_modifier(array<string|int, mixed> $saisies, unknown_type $id_ou_nom_ou_chemin, array<string|int, mixed> $modifs[, bool $fusion = false ]) : Retourne
Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

$id_ou_nom_ou_chemin : unknown_type

L'identifiant unique ou le nom ou le chemin de la saisie à modifier

$modifs : array<string|int, mixed>

Le tableau des modifications à apporter à la saisie

$fusion : bool = false

True si on veut simplifier rajouter des choses, sans tout remplacer

Return values
Retourne

le tableau décrivant les saisies, mais modifié

saisies_transformer_noms()

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>
Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

$masque : string

Ce que l'on doit chercher dans le nom

$remplacement : string

Ce par quoi on doit remplacer

Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_transformer_option()

Transforme toutes les options textuelles d'un certain nom, avec un preg_replace.

saisies_transformer_option( $saisies,  $option,  $masque,  $remplacement[, bool $recursif = True ]) : array<string|int, mixed>
Parameters
$saisies :

Tableau décrivant les saisies

$option :

Nom de l'option à transformer (par ex "nom", ou "afficher_si"), ou tableau

$masque :

Ce que l'on doit chercher dans le texte

$remplacement :

Ce par quoi on doit remplacer

$recursif : bool = True
Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_mapper_option()

Modifie toutes les options d'un certain nom, avec une fonction de rappel.

saisies_mapper_option(array<string|int, mixed> $saisies, str|array<string|int, mixed> $options, str $callback[, array<string|int, mixed> $args = [] ][, mixed $recursif = True ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>

Tableau décrivant les saisies

$options : str|array<string|int, mixed>

Nom de l'option à transformer (par ex "nom", ou "afficher_si") Ou tableau de noms

$callback : str

Nom de la fonction à appliquer

$args : array<string|int, mixed> = []

Arguments de la fonction de rappel La valeur de l'option est passée automatiquement en premier

$recursif : mixed = True
Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_supprimer_option()

Supprime toutes les options textuelles d'un certain nom, avec un preg_replace.

saisies_supprimer_option( $saisies,  $option[, bool $recursif = True ]) : array<string|int, mixed>
Parameters
$saisies :

Tableau décrivant les saisies

$option :

Nom de l'option à supprimer (par ex "nom", ou "afficher_si")

$recursif : bool = True
Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_transformer_noms_auto()

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>
Parameters
$formulaire : array<string|int, mixed>

Le formulaire à analyser

$saisies : array<string|int, mixed>

Un tableau décrivant les saisies.

Return values
array<string|int, mixed>

Retourne le tableau modifié des saisies

saisies_inserer_html()

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>
Parameters
$saisie : array<string|int, mixed>

La description d'une seule saisie

$insertion : string

Du code HTML à insérer dans la saisie

$ou : string = 'fin'

L'endroit où insérer le HTML : "debut" ou "fin"

Return values
array<string|int, mixed>

Retourne la description de la saisie modifiée

saisies_fieldsets_en_onglets()

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 = '' ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>
$identifiant_prefixe : string = ''
Return values
array<string|int, mixed>

$saisies modifiées

saisies_migrer_afficher_si_remplissage()

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>
Parameters
$saisies : array<string|int, mixed>

Les saisies initiales

Return values
array<string|int, mixed>

$saisies Les saisies modifiées

saisie_nom2classe()

Passer un nom en une valeur compatible avec une classe css

saisie_nom2classe(string $nom) : string
  • toto => toto,
  • toto/truc => toto_truc,
  • toto[truc] => toto_truc
Parameters
$nom : string
Return values
string

saisie_type2classe()

Ajouter une ou des classes sur la saisie en fonction du type

saisie_type2classe( $type_saisie) : string
Parameters
$type_saisie :
Return values
string

saisie_nom2name()

Passer un nom en une valeur compatible avec un `name` de formulaire

saisie_nom2name(string $nom) : string
  • toto => toto,
  • toto/truc => toto[truc],
  • toto/truc/ => toto[truc][],
  • toto[truc] => toto[truc]
Parameters
$nom : string
Tags
see
saisie_name2nom()

pour l'inverse.

Return values
string

saisie_name2nom()

Passer un `name` en un format de nom compris de saisies

saisie_name2nom(string $name) : string
  • toto => toto,
  • toto[truc] => toto/truc,
  • toto[truc][] => toto/truc/
  • toto/truc => toto/truc
Parameters
$name : string
Tags
see
saisie_nom2name()

pour l'inverse.

Return values
string

saisies_cles_nom2name()

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>
Parameters
$tab : array<string|int, mixed>
Return values
array<string|int, mixed>

saisies_request()

Trouve le résultat d'une saisie (_request()) en tenant compte du fait que la saisie peut être décrit 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>
Parameters
$champ : string

Nom du champ de la saisie, y compris avec crochets pour sous entrées

$valeurs : null|array<string|int, mixed> = null

Tableau où chercher, à defaut get/post

Return values
string|array<string|int, mixed>

Résultat du _request()

saisies_request_from_FILES()

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
Parameters
$champ : string
Return values
array<string|int, mixed>|null

saisies_request_property_from_FILES()

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>
Parameters
$champ : string

Nom du champ de la saisie, y compris avec crochets pour sous entrées

$property : string = 'name'
Tags
todo

Prendre en compte aussi la notation champ/index/index

Return values
string|array<string|int, mixed>

Résultat du _request()

saisies_set_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,  $valeur[, array<string|int, mixed> $valeurs = null ]) : void
Parameters
$champ : mixed
$valeur :

Valeur à remplir dans le request

$valeurs : array<string|int, mixed> = null

Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST

Tags
todo

Prendre un arg en plus pour enregistrer la valeur dans un autre tableau que le GET/POST

Return values
void

saisies_liste_set_request()

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 ]) : mixed
Parameters
$action : string = 'set'

'set|get'

$champ : string = 'null'
$nouvelle_valeur : string = ''
$valeurs : array<string|int, mixed> = null

Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST

Return values
mixed

saisies_get_valeur_saisie()

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>
Parameters
$saisie : array<string|int, mixed>
$valeurs : array<string|int, mixed> = null

Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST

Return values
string|array<string|int, mixed>

$valeur

saisies_verifier()

Vérifier tout un formulaire tel que décrit avec les Saisies

saisies_verifier(array<string|int, mixed> $formulaire[, mixed $saisies_masquees_empty_string = true ][,  $etape = null ][, array<string|int, mixed> $valeurs = null ]) : array<string|int, mixed>
Parameters
$formulaire : array<string|int, mixed>

Le formulaire à vérifier, c'est à dire un tableau de saisies, avec éventuellement une clé options, comprenant tout les étapes

$saisies_masquees_empty_string : mixed = true
$etape : = null

l'étape courante à vérifier

$valeurs : array<string|int, mixed> = null

Optionnellement un tableau de valeurs à passer à _request plutôt que GET/POST

Return values
array<string|int, mixed>

Retourne un tableau d'erreurs

saisies_verifier_valeurs_acceptables()

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( $saisies,  $erreurs) : array<string|int, mixed>

Typiquement pour une saisie radio, vérifier que les gens n'ont pas postée une autre fleur.

Parameters
$saisies :

array tableau général des saisies, déjà aplati, classé par nom de champ

$erreurs :

array tableau des erreurs

Return values
array<string|int, mixed>

table des erreurs modifiés

construire_configuration_saisie()

construire_configuration_saisie(mixed $saisie[, mixed $avec_nom = 'non' ]) : mixed
Parameters
$saisie : mixed
$avec_nom : mixed = 'non'
Return values
mixed

auteurs_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

case_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

checkbox_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

date_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

email_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

hidden_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

input_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

oui_non_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

radio_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

selection_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

selection_multiple_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

textarea_valeurs_acceptables()

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
Parameters
$valeur : string

la valeur postée

$description : array<string|int, mixed>

la description de la saisie

Return values
bool

true si valeur ok, false sinon,

saisies_upgrade()

Installation/maj des config de saisies

saisies_upgrade(string $nom_meta_base_version, string $version_cible) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

Return values
void

saisies_vider_tables()

saisies_vider_tables(mixed $nom_meta_base_version) : mixed
Parameters
$nom_meta_base_version : mixed
Return values
mixed

saisies_afficher_si_js_defaut()

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
Parameters
$parse : array<string|int, mixed>

analyse syntaxique du tests à effectuer (sous tableau de résultat de saisies_parser_condition_afficher_si())

$saisies_form : array<string|int, mixed>

ensemble des saisies du formulaire, listées par nom

Return values
mixed

saisie_balise_structure_formulaire()

Retourne une balise dev. Maintenu pour compatibilité historique, ne plus utiliser.

saisie_balise_structure_formulaire( $tag) : string
Parameters
$tag :

ul ou li

Tags
deprecated

Comportement antérieure : Retournait une balise div si on est en SPIP >= 3.1, sinon le texte en parametre.

example

[(#VAL{ul}|saisie_balise_structure_formulaire)]

see
balise_DIV_dist()

pour une écriture plus courte.

note

Préférer [(#DIV|sinon{ul})] dans les squelettes, plus lisible.

Return values
string

$tag initial ou div

balise_DIV_dist()

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

  • ul.editer-groupe deviennent des div.editer-groupe
  • li.editer devient div.editer
Parameters
$p : Pile
Tags
deprecated
see
saisie_balise_structure_formulaire()
example

[(#DIV|sinon{ul})]

Return values
Pile

saisie_traitement_vue()

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 $valeur, string|array<string|int, mixed> $env) : string
Parameters
$valeur : string
$env : string|array<string|int, mixed>
Return values
string

balise_GLOBALS_dist()

Compile la balise `#GLOBALS{xxx}` qui retourne la valeur d'une vilaine variable globale de même nom si elle existe

balise_GLOBALS_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
example
#GLOBALS{debut_intertitre}
Return values
Champ

Pile complétée du code php de la balise.

picker_selected_par_objet()

Liste les éléments du sélecteur générique triés

picker_selected_par_objet(string $selected) : array<string|int, mixed>

Les éléments sont triés par objets puis par identifiants

Parameters
$selected : string

Liste des objets sélectionnés

Tags
example

L'entrée : 'rubrique|3,rubrique|5,article|2' Retourne : array( 0 => array('objet'=>'article', 'id_objet' => 2), 1 => array('objet'=>'rubrique', 'id_objet' => 3), 2 => array('objet'=>'rubrique', 'id_objet' => 5), )

Return values
array<string|int, mixed>

Liste des objets triés

lister_tables_objets_edit()

Lister les objets qui ont une url_edit renseignée et qui sont éditables.

lister_tables_objets_edit() : array<string|int, mixed>
Return values
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.

saisies_label()

Afficher la chaine de langue traduite.

saisies_label(string $chaine) : string
Parameters
$chaine : string
Return values
string

saisies_liens_ouvrants()

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

Parameters
$texte : string
Return values
string

$texte

saisies_statut_titre()

Afficher un statut traduit

saisies_statut_titre(string $statut[, string $objet = '' ]) : string
Parameters
$statut : string

Le statut (publie, refuse, ...)

$objet : string = ''

Le type d’objet (article, rubrique, ...)

Return values
string

La traduction du statut, si on la trouve, sinon simplement la clé...

saisies_picker_preselect_objet()

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.

Parameters
$valeur : array<string|int, mixed>|string|int
  • Soit un tableau issu du sélecteur (dans ce cas on ne fait rien) : array('article|1', 'article|2')
  • Soit l'id d'un objet : 1
  • Soit un tableau d'ids : array(1,2)
$objet : string
Tags
example
  • Entrée : 10, sortie : array('article|10')
  • Entrée : array(10,20), sortie : array('article|10', 'article|20')
see
picker_selected()
Return values
array<string|int, mixed>

Tableau au format du sélecteur générique

saisies_utf8_restaurer_planes()

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
Parameters
$x : string|null
Return values
string

saisies_header_prive()

Ajoute les scripts JS et CSS de saisies dans l'espace privé

saisies_header_prive(string $flux) : string
Parameters
$flux : string
Return values
string

saisies_insert_head()

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>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

$flux modifié

saisies_affichage_final()

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.

Parameters
$flux : string
Return values
string

saisies_generer_head()

Génère le contenu du head pour les saisies (css et js)

saisies_generer_head([str $html_content = '' ][, mixed $tester_saisies = false ]) : string
Parameters
$html_content : str = ''

le contenu html où l'on teste la présence de saisies

$tester_saisies : mixed = false
Return values
string

saisies_formulaire_charger()

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.

Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

saisies_preremplir_defaut_depuis_config()

Pre remplir les options 'defaut' des saisies depuis `lire_config()`

saisies_preremplir_defaut_depuis_config(mixed $saisies, mixed $meta_case) : array<string|int, mixed>
Parameters
$saisies : mixed
$meta_case : mixed
Return values
array<string|int, mixed>

$saisies

saisies_styliser()

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.

Parameters
$flux : array<string|int, mixed>
Tags
see
saisies_formulaire_charger()
Return values
array<string|int, mixed>

saisies_formulaire_verifier()

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.

Parameters
$flux : array<string|int, mixed>

Liste des erreurs du formulaire

Tags
see
saisies_formulaire_charger()
uses
saisies_verifier()
Return values
array<string|int, mixed>

iste des erreurs

saisies_formulaire_verifier_etape()

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>
Parameters
$flux : array<string|int, mixed>

Liste des erreurs du formulaire

Tags
see
saisies_formulaire_charger()
uses
saisies_verifier()
Return values
array<string|int, mixed>

iste des erreurs

saisies_formulaire_receptionner()

À la réception d'un formulaire de config rechercher les input avec l'option cle_secrete.

saisies_formulaire_receptionner(mixed $flux) : array<string|int, mixed>

Si la valeur postée est vide, cela veut dire qu'on conserve celle en base. Dans ce cas, reinjecter cette dernière en `set_request'. Cela permet de ne pas perdre la valeur à chaque configuration du formulaire

Parameters
$flux : mixed
Return values
array<string|int, mixed>

$flux;

afficher_si_definir_fonctions()

Retourne une chaine renvoyant les functions js de masquage/affiche

afficher_si_definir_fonctions() : mixed
Return values
mixed

verifier_afficher_si_dist()

verifier_afficher_si_dist(string $valeur) : string
Parameters
$valeur : string

La valeur à vérifier.

Return values
string

Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.

verifier_saisies_option_data_dist()

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[,  $options = array() ]) : string

On en profite pour vérifier qu'il n'y pas de clé en double. De plus les trim() pertubent les choses.

Parameters
$valeur : string

La valeur à vérifier.

$options : = array()

interdire_sous_groupes => True|False verifier_cles => array décrivant une vérification à effectuer

Return values
string

Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.

verifier_valeurs_acceptables_dist()

verifier_valeurs_acceptables_dist(string $valeur, mixed $options) : string
Parameters
$valeur : string

La valeur à vérifier.

$options : mixed
Return values
string

Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.

Search results