SPIP Code

Documentation du code de SPIP et de ses plugins

Saisies pour formulaires

saisies_data.php

Trouver et manipuler les data des saisies, qu'elles soient sous forme tabulaire ou sous forme de liste

Table of Contents

Functions

saisies_aplatir_chaine()  : string
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_liste_choix()  : array<string|int, mixed>
Prend une liste de choix (clés de tableau data) en entrée Si tableau, renvoi presque tel quel Si chaine, l'explose au niveau des virgules Trim dans tous les cas les différents choix
saisies_normaliser_disable_choix()  : array<string|int, mixed>
saisies_depublier_data()  : array<string|int, mixed>
Prend un tableau de data enlève les choix dépubliés sauf si la valeur courante de la saisie
saisies_lister_necessite_retenir_ancienne_valeur()  : array<string|int, mixed>
Return la liste des saisies qui nécessite qu'on insère un hidden avec les précédentes valeurs.

Functions

saisies_aplatir_chaine()

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

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

La chaîne à aplatir

Return values
string

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

Options data de la saisie

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

Prend une liste de choix (clés de tableau data) en entrée Si tableau, renvoi presque tel quel Si chaine, l'explose au niveau des virgules Trim dans tous les cas les différents choix

saisies_normaliser_liste_choix(array<string|int, mixed>|string $liste) : array<string|int, mixed>
Parameters
$liste : array<string|int, mixed>|string
Return values
array<string|int, mixed>

saisies_normaliser_disable_choix()

saisies_normaliser_disable_choix(array<string|int, mixed>|string $liste) : array<string|int, mixed>
Parameters
$liste : array<string|int, mixed>|string
Tags
deprecated

Ancien nom de la fonction saisies_normaliser_liste_choix

Return values
array<string|int, mixed>

saisies_depublier_data()

Prend un tableau de data enlève les choix dépubliés sauf si la valeur courante de la saisie

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

saisies_lister_necessite_retenir_ancienne_valeur()

Return la liste des saisies qui nécessite qu'on insère un hidden avec les précédentes valeurs.

saisies_lister_necessite_retenir_ancienne_valeur(array<string|int, mixed> $saisies) : array<string|int, mixed>

C'est à dire : uniquement les saisies qui sont des depublies et sousmis à test de valeurs_acceptables

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

description complète de saisies

Return values
array<string|int, mixed> —

$liste_saisies


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results