Documentation du code de SPIP et de ses plugins

SPIP

formulaire_.php

Fonctions génériques pour les balises formulaires

Table of Contents

Functions

protege_champ()  : string|array<string|int, mixed>|null
Protéger les saisies d'un champ de formulaire
existe_formulaire()  : string|bool
Teste si un formulaire demandé possède un squelette pour l'afficher
test_formulaire_inclus_par_modele()  : false|array<string|int, mixed>
Tester si un formulaire est appele via un modele type <formulaire|...> et le cas echeant retourne les arguments passes au modele false sinon
balise_FORMULAIRE__dist()  : Champ
Balises Formulaires par défaut.
balise_FORMULAIRE__dyn()  : string|array<string|int, mixed>
Balise dynamiques par défaut des formulaires
balise_FORMULAIRE__contexte()  : array<string|int, mixed>|string
Calcule le contexte à envoyer dans le squelette d'un formulaire
formulaire__charger()  : array<string|int, mixed>
Charger les valeurs de saisie du formulaire
formulaire__identifier()  : bool
Vérifier que le formulaire en cours est celui qui est poste

Functions

protege_champ()

Protéger les saisies d'un champ de formulaire

protege_champ(mixed $valeur[, mixed $max_prof = 128 ]) : string|array<string|int, mixed>|null

Proteger les ' et les " dans les champs que l'on va injecter, sans toucher aux valeurs sérialisées

Parameters
$valeur : mixed

Saisie à protéger

$max_prof : mixed = 128
Tags
see
spip_htmlspecialchars()
Return values
string|array<string|int, mixed>|null

Saisie protégée

existe_formulaire()

Teste si un formulaire demandé possède un squelette pour l'afficher

existe_formulaire(string $form) : string|bool
Parameters
$form : string

Nom du formulaire

Tags
see
trouver_fond()
Return values
string|bool
  • string : chemin du squelette
  • false : pas de squelette trouvé

test_formulaire_inclus_par_modele()

Tester si un formulaire est appele via un modele type <formulaire|...> et le cas echeant retourne les arguments passes au modele false sinon

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

balise_FORMULAIRE__dist()

Balises Formulaires par défaut.

balise_FORMULAIRE__dist(Champ $p) : Champ

Compilé en un appel à une balise dynamique.

Parameters
$p : Champ

Description de la balise formulaire

Return values
Champ

Description complétée du code compilé appelant la balise dynamique

balise_FORMULAIRE__dyn()

Balise dynamiques par défaut des formulaires

balise_FORMULAIRE__dyn(string $form, array<string|int, mixed> ...$args) : string|array<string|int, mixed>
Parameters
$form : string

Nom du formulaire

$args : array<string|int, mixed>

Arguments envoyés à l'appel du formulaire

Tags
note

Deux moyen d'arriver ici : soit #FORMULAIRE_XX reroute avec 'FORMULAIRE_XX' ajoute en premier arg soit #FORMULAIRE_{xx}

Return values
string|array<string|int, mixed>
  • array : squelette à appeler, durée du cache, contexte
  • string : texte à afficher directement

balise_FORMULAIRE__contexte()

Calcule le contexte à envoyer dans le squelette d'un formulaire

balise_FORMULAIRE__contexte(string $form, array<string|int, mixed> $args) : array<string|int, mixed>|string
Parameters
$form : string

Nom du formulaire

$args : array<string|int, mixed>

Arguments envoyés à l'appel du formulaire

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

array: contexte d'environnement à envoyer au squelette string: Formulaire non applicable (message d’explication)

formulaire__charger()

Charger les valeurs de saisie du formulaire

formulaire__charger(string $form, array<string|int, mixed> $args, bool $poste) : array<string|int, mixed>
Parameters
$form : string
$args : array<string|int, mixed>
$poste : bool
Return values
array<string|int, mixed>

formulaire__identifier()

Vérifier que le formulaire en cours est celui qui est poste

formulaire__identifier(string $form, array<string|int, mixed> $args, array<string|int, mixed> $p) : bool

On se base sur la fonction identifier (si elle existe) qui fournit une signature identifiant le formulaire a partir de ses arguments significatifs

En l'absence de fonction identifier, on se base sur l'egalite des arguments, ce qui fonctionne dans les cas simples

Parameters
$form : string
$args : array<string|int, mixed>
$p : array<string|int, mixed>
Return values
bool

        
On this page

Search results