Documentation du code de SPIP et de ses plugins

Saisies pour formulaires

saisies_formulaire.php

Oautils pour faciliter la construction de formulaires CVT sous formes de listes de saisies

Table of Contents

Functions

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()`
saisies_resumer_etapes_futures()  : array<string|int, mixed>
Retourne un résumé des étapes futures (qu'elles s'afficheront finalement ou pas).
saisies_determiner_options_demandees_resumer_etapes_futures()  : array<string|int, mixed>
Détermine quels options d'étapes sont utiles au résumé des étapes futures En fonction des options globales du formulaire

Functions

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 précédentes

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, potentiellement déjà classées par étapes

$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

saisies_resumer_etapes_futures()

Retourne un résumé des étapes futures (qu'elles s'afficheront finalement ou pas).

saisies_resumer_etapes_futures(array<string|int, mixed> $etapes, int $etape, array<string|int, mixed> $options_demandees) : array<string|int, mixed>
Parameters
$etapes : array<string|int, mixed>

liste des étapes (sous forme de tableau de saisies)

$etape : int

etape courante

$options_demandees : array<string|int, mixed>

tableau décrivant les options qu'on demande

Return values
array<string|int, mixed>

[ 'etape_n' => ['info_x' => 'valeur_x', 'info_y' => 'valeur_y' …] … ]

saisies_determiner_options_demandees_resumer_etapes_futures()

Détermine quels options d'étapes sont utiles au résumé des étapes futures En fonction des options globales du formulaire

saisies_determiner_options_demandees_resumer_etapes_futures(array<string|int, mixed> $options_globales) : array<string|int, mixed>
Parameters
$options_globales : array<string|int, mixed>

optiosn globales du formulaire

Return values
array<string|int, mixed>

liste des options à garder


        
On this page

Search results