request.php
Table of Contents
Functions
- _request() : mixed|null
- Renvoie le query ou le request bag émis par l'utilisateur ou pioché dans un tableau transmis.
- set_request() : array<string|int, mixed>|null
- Affecte une valeur à une clé (pour usage avec `_request()`)
- spip_sanitize_from_request() : array<string|int, mixed>|mixed|string
- Sanitizer une valeur *SI* elle provient du GET ou POST
- spip_sanitize_env_from_request() : array<string|int, mixed>
- Sanitizer tout ou partie des valeurs d'environnement
Functions
_request()
Renvoie le query ou le request bag émis par l'utilisateur ou pioché dans un tableau transmis.
_request(string $var[, array<string|int, mixed>|null|false $c = null ]) : mixed|null
Lit depuis le RequestStack Symfony (service DI request_stack)
lorsqu'une Request est disponible.
Parameters
- $var : string
-
Clé souhaitée
- $c : array<string|int, mixed>|null|false = null
-
Tableau transmis (sinon cherche dans GET ou POST)
Return values
mixed|null —- null si la clé n'a pas été trouvée
- la valeur de la clé sinon.
set_request()
Affecte une valeur à une clé (pour usage avec `_request()`)
set_request(string $var[, string $val = null ][, array<string|int, mixed>|null|false $c = null ]) : array<string|int, mixed>|null
Met à jour la Request Symfony (via le RequestStack).
Parameters
- $var : string
-
Nom de la clé
- $val : string = null
-
Valeur à affecter
- $c : array<string|int, mixed>|null|false = null
-
Tableau de données (sinon utilise la Request courante)
Tags
Return values
array<string|int, mixed>|null —- array $c complété si un $c est transmis,
- null sinon
spip_sanitize_from_request()
Sanitizer une valeur *SI* elle provient du GET ou POST
spip_sanitize_from_request(string|array<string|int, mixed> $value, string $key[, string $sanitize_function = 'entites_html' ]) : array<string|int, mixed>|mixed|string
Utile dans les squelettes pour les valeurs qu'on attrape dans le env, dont on veut permettre à un squelette de confiance appelant de fournir une valeur complexe mais qui doit etre nettoyee si elle provient de l'URL
On peut sanitizer
- une valeur simple :
$where = spip_sanitize_from_request($value, 'where')
Parameters
- $value : string|array<string|int, mixed>
- $key : string
- $sanitize_function : string = 'entites_html'
Return values
array<string|int, mixed>|mixed|stringspip_sanitize_env_from_request()
Sanitizer tout ou partie des valeurs d'environnement
spip_sanitize_env_from_request(array<string|int, mixed> $values[, array<string|int, mixed>|null $keys = null ][, string $sanitize_function = 'entites_html' ]) : array<string|int, mixed>
Chaque valeur (ou seulement les clés choisies) passeront dans spip_sanitize_from_request
qui sanitisera la valeur si elle provient de GET ou POST
On peut sanitizer tout ou partie de l'environnement
- un tableau en partie :
$env = spip_sanitize_env_from_request($env, ['key1','key2']) - un tableau complet :
$env = spip_sanitize_env_from_request($env)
Parameters
- $values : array<string|int, mixed>
- $keys : array<string|int, mixed>|null = null
- $sanitize_function : string = 'entites_html'