\Request

Provee métodos para acceder al request.

Summary

Methods
Properties
Constants
esSeguro()
esquema()
metodo()
host()
puerto()
hostYPuerto()
existe()
existePost()
existeGet()
obtener()
obtenerPost()
obtenerGet()
almacenar()
almacenarPost()
almacenarGet()
eliminar()
eliminarGet()
eliminarPost()
ipOrigen()
trazaOrigen()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

esSeguro()

esSeguro() : boolean

Permite comprobar si la consulta es segura (llegó por HTTPS).

Returns

boolean —

true si la consulta es segura

esquema()

esquema() : string

Retorna el esquema usado en el request.

Returns

string —

'https' o 'http'

metodo()

metodo() : string

Retorna el método HTTP con que se hizo el request.

Returns

string —

el nombre del método, siempre en mayúsculas

host()

host() : string|null

Retorna el nombre del host al que llegó el request.

Throws

\UnexpectedValueException

si el nombre no es válido

Returns

string|null —

el nombre, o null si no puede determinarlo

puerto()

puerto() : integer|null

Retorna el puerto al que llegó el request.

Returns

integer|null —

el número de puerto; null si el puerto no se puede determinar

hostYPuerto()

hostYPuerto() : string|null

Retorna el nombre de host y puerto al que llegó el request.

El formato del resultado es

"{host}:{puerto}" si se puede determinar el puerto, "{host}" si no.

Throws

\UnexpectedValueException

si el nombre de host obtenido no es válido

Returns

string|null — "{host}[:{puerto}]"; null si no puede determinar el host ni el puerto

existe()

existe(string  $variable) : boolean

Permite comprobar si existe una variable dentro del request.

Parameters

string $variable

nombre de la variable

Returns

boolean

existePost()

existePost(string  $variable) : boolean

Permite comprobar si existe una variable dentro del request enviada por POST.

Parameters

string $variable

nombre de la variable

Returns

boolean

existeGet()

existeGet(string  $variable) : boolean

Permite comprobar si existe una variable dentro del request enviada por GET.

Parameters

string $variable

nombre de la variable

Returns

boolean

obtener()

obtener(string  $variable, mixed  $por_defecto = '', boolean  $trim = true, boolean  $stripslashes = false, boolean  $ajustar_si_array = false) : mixed

Retorna el valor de una variable en el request.

Parameters

string $variable

nombre de la variable a obtener

mixed $por_defecto

valor a retornar si la variable no está en el request

boolean $trim

¿se debe hacer trim al valor?

boolean $stripslashes

¿se deben quitar las barras de escape al valor? (teniendo en cuenta get_magic_quotes_gpc())

boolean $ajustar_si_array

si el valor es un array ¿se deben aplicar a cada elemento los ajustes indicados por $trim y $stripslashes?

Returns

mixed

obtenerPost()

obtenerPost(string  $variable, mixed  $por_defecto = '', boolean  $trim = true, boolean  $stripslashes = false, boolean  $ajustar_si_array = false) : mixed

Retorna el valor de una variable en el request enviada por POST.

Parameters

string $variable

nombre de la variable a obtener

mixed $por_defecto

valor a retornar si la variable no está en el request

boolean $trim

¿se debe hacer trim al valor?

boolean $stripslashes

¿se deben quitar las barras de escape al valor? (teniendo en cuenta get_magic_quotes_gpc())

boolean $ajustar_si_array

si el valor es un array ¿se deben aplicar a cada elemento los ajustes indicados por $trim y $stripslashes?

Returns

mixed

obtenerGet()

obtenerGet(string  $variable, mixed  $por_defecto = '', boolean  $trim = true, boolean  $stripslashes = false, boolean  $ajustar_si_array = false) : mixed

Retorna el valor de una variable en el request enviada por GET.

Parameters

string $variable

nombre de la variable a obtener

mixed $por_defecto

valor a retornar si la variable no está en el request

boolean $trim

¿se debe hacer trim al valor?

boolean $stripslashes

¿se deben quitar las barras de escape al valor? (teniendo en cuenta get_magic_quotes_gpc())

boolean $ajustar_si_array

si el valor es un array ¿se deben aplicar a cada elemento los ajustes indicados por $trim y $stripslashes?

Returns

mixed

almacenar()

almacenar(string  $nombre, string  $variable,   $especifico = null) 

Almacena una variable dentro de <var>$_REQUEST</var>.

Opcionalmente, puede almacenarla también en otro array.

Parameters

string $nombre

nombre de la variable

string $variable

valor a guardar

$especifico

almacenarPost()

almacenarPost(string  $nombre, string  $variable, boolean  $actualizar_request = false) 

Almacena una variable dentro de <var>$_POST</var> y opcionalmente también en <var>$_REQUEST</var>.

Parameters

string $nombre

nombre de la variable

string $variable

valor a guardar

boolean $actualizar_request

¿se debe almacenar la variable en $_REQUEST además de $_POST?

almacenarGet()

almacenarGet(string  $nombre, string  $variable, boolean  $actualizar_request = false) 

Almacena una variable dentro de <var>$_GET</var> y opcionalmente también en <var>$_REQUEST</var>.

Parameters

string $nombre

nombre de la variable

string $variable

valor a guardar

boolean $actualizar_request

¿se debe almacenar la variable en $_REQUEST además de $_GET?

eliminar()

eliminar(string  $nombre, boolean  $actualizar_especificos = false) 

Elimina una variable de <var>$_REQUEST</var> y opcionalmente también de <var>$_GET</var> y <var>$_POST</var>.

No tiene efecto si la variable no está en $_REQUEST.

Parameters

string $nombre

nombre de la variable

boolean $actualizar_especificos

¿se debe eliminar la variable también de $_GET y $_POST?

eliminarGet()

eliminarGet(string  $nombre, boolean  $actualizar_request = false) 

Elimina una variable de <var>$_GET</var> y opcionalmente también de <var>$_REQUEST</var>.

No tiene efecto si la variable no está en $_GET.

Parameters

string $nombre

nombre de la variable

boolean $actualizar_request

¿eliminar de $_REQUEST también?

eliminarPost()

eliminarPost(string  $nombre, boolean  $actualizar_request = false) 

Elimina una variable de <var>$_POST</var> y opcionalmente también de <var>$_REQUEST</var>.

No tiene efecto si la variable no está en $_POST.

Parameters

string $nombre

nombre de la variable

boolean $actualizar_request

¿eliminar de $_REQUEST también?

ipOrigen()

ipOrigen() : string

Devuelve el IP de origen del request.

Busca el valor más conveniente entre las siguientes variables del servidor, dadas en orden de prioridad:

  1. HTTP_CLIENT_IP
  2. HTTP_X_FORWARDED_FOR
  3. HTTP_X_FORWARDED
  4. HTTP_X_CLUSTER_CLIENT_IP
  5. HTTP_FORWARDED_FOR
  6. HTTP_FORWARDED
  7. REMOTE_ADDR Notar que el resultado puede ser un IP privado, dependiendo de la configuración de la red, o hasta puede ser un IP falso si el cliente inyecta cabeceras en el pedido.

Returns

string

trazaOrigen()

trazaOrigen() : array

Devuelve un arreglo conteniendo todas las variables del servidor que tienen información sobre el origen del request.

Las variables que se buscan son:

  • HTTP_CLIENT_IP,
  • HTTP_X_FORWARDED_FOR,
  • HTTP_X_FORWARDED,
  • HTTP_X_CLUSTER_CLIENT_IP,
  • HTTP_FORWARDED_FOR,
  • HTTP_FORWARDED,
  • REMOTE_ADDR

Returns

array —

la lista de variables presentes, como pares nombre de variable => valor, en el orden indicado