Documentation du code de SPIP et de ses plugins

Saisies pour formulaires

saisies_manipuler.php

Gestion de la manipulation des saisies.

Table of Contents

Functions

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()  : array<string|int, mixed>
Modifie une saisie.
saisies_transformer_noms()  : array<string|int, mixed>
Transforme tous les noms du formulaire avec un preg_replace.
saisies_encapsuler_noms()  : array<string|int, mixed>
Transforme tous les noms en les encapsulant avec un préfixe.
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 d'un certain nom.
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_supprimer_sans_reponse()  : array<string|int, mixed>
Prend un tableau de saisies Enlève les saisies qui n'ont rien dans _request Ou dont l'ensemble des sous-saisies sont vides

Functions

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<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 = []
  • 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<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> = []

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, array<string|int, mixed>|string $id_ou_nom_ou_chemin, array<string|int, mixed> $modifs[, bool $fusion = false ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>

Un tableau décrivant les saisies

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

L'identifiant 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
array<string|int, mixed>

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

Transforme tous les noms en les encapsulant avec un préfixe.

saisies_encapsuler_noms(array<string|int, mixed> $saisies, string $prefixe[, bool $recursif = true ]) : array<string|int, mixed>

Cela permet d'avoir toutes les valeurs postées dans un unique tableau. Après transformation, on pourra faire _request(<prefixe>) pour les récupérer.

Utilisation possible : on mélange les saisies de plusieurs formulaires, et on a dans ce cas besoin de cloisonner les valeurs.

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

Un tableau décrivant les saisies

$prefixe : string

Préfixe

$recursif : bool = true

Pour procéder récursivement dans les fieldsets

Tags
example

Avant/après

  • bidule → prefixe[bidule]
  • machin[chose] → prefixe[machin][chose]
Return values
array<string|int, mixed>

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 Note : si l'option n'existe pas, elle est automatiquement mise à '' avant toute transformation

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

Nom de l'option à transformer (par ex "nom", ou "afficher_si") Ou tableau de noms Note : si l'option n'existe pas, elle est automatiquement mise à '' avant toute transformation

$callback : string

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 d'un certain nom.

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

$saisies modifiées

saisies_supprimer_sans_reponse()

Prend un tableau de saisies Enlève les saisies qui n'ont rien dans _request Ou dont l'ensemble des sous-saisies sont vides

saisies_supprimer_sans_reponse(array<string|int, mixed> $saisies[, optional $tableau = [] ]) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>
$tableau : optional = []

(tableau pour chercher dans request)

Return values
array<string|int, mixed>

        
On this page

Search results