Documentation du code de SPIP et de ses plugins

Saisies pour formulaires

saisies_afficher_si_php.php

Gestion de l'affichage conditionnelle des saisies.

Partie spécifique php

Table of Contents

Functions

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
Recherche les saisies qui ont été masquées par afficher_si et les mets à `''`, sauf si * - options globales de saisies : `afficher_si_avec_post` * - option de la saisie spécifique : `afficher_si_avec_post` Cette fonction est appelée à la toute fin de `saisies_verifier()`
saisies_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 Si le champ est de type @plugin:xx@, vérifier si le plugin est actif 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

Functions

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<string|int, mixed>

Lorsque qu'on affiche les saisies avec #VOIR_SAISIES, ou lorsqu'on les vérifie avec saisies_verifier(). Si la condition d'affichage d'une saisie n'est pas remplie, on retire cette saisie du tableau de saisies, SAUF SI l'option afficher_si_remplissage_uniquement est activée et que $env est non null.

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

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

Recherche les saisies qui ont été masquées par afficher_si et les mets à `''`, sauf si * - options globales de saisies : `afficher_si_avec_post` * - option de la saisie spécifique : `afficher_si_avec_post` Cette fonction est appelée à la toute fin de `saisies_verifier()`

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

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

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 Si le champ est de type @plugin:xx@, vérifier si le plugin est actif Sinon en _request() ou en $env["valeurs"]

saisies_afficher_si_get_valeur_champ(string $champ, null|array<string|int, mixed> $env, array<string|int, mixed> $saisies_par_nom) : 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 = [] ][, 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> = []

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

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

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

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

complète

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

        
On this page

Search results