Solicitar clase
La clase de solicitud es una representación orientada a objetos de una solicitud HTTP. Esto está destinado a funciona tanto para solicitudes entrantes, como una solicitud a la aplicación desde un navegador, como para solicitudes salientes, like se usaría para enviar una solicitud desde la aplicación a una aplicación de terceros.
Esta clase proporciona la funcionalidad común que ambos necesitan, pero ambos casos tienen clases personalizadas que amplían de la clase Solicitud para agregar una funcionalidad específica. En la práctica, necesitarás utilizar estas clases.
Consulte la documentación para Clase IncomingRequest y CURLRequest Class para obtener más detalles de uso.
Referencia de clase
- class Higgs\HTTP\Request
- getIPAddress()
- Devuelve:
la dirección IP del usuario, si se puede detectar. Si la dirección IP no es una dirección IP válida, devolverá
0.0.0.0
.- Tipo del valor devuelto:
cadena
Devuelve la dirección IP del usuario actual. Si la dirección IP no es válida, el método devolverá
0.0.0.0
:<?php echo $request->getIPAddress();
Importante
This method takes into account the
Config\App::$proxyIPs
setting and will devuelve la dirección IP del cliente informada mediante el encabezado HTTP para la dirección IP permitida.
- isValidIP($ip[, $which = ''])
Obsoleto desde la versión 7.0.5: Utilice Validation en su lugar.
Importante
This method is deprecated. It will be removed in future releases.
- Parámetros:
$ip (
string
) – dirección IP$cual (
string
) – protocolo IP (ipv4
oipv6
)
- Devuelve:
verdadero si la dirección es válida, falso si no
- Tipo del valor devuelto:
booleano
Toma una dirección IP como entrada y devuelve verdadero o falso (booleano) dependiendo sobre si es válido o no.
Nota
The $request->getIPAddress() method above automatically validates the IP address.
<?php if (! $request->isValidIP($ip)) { echo 'Not Valid'; } else { echo 'Valid'; }
Acepta un segundo parámetro de cadena opcional de
ipv4
oipv6
para especificar un formato IP. El valor predeterminado comprueba ambos formatos.
- getMethod([$upper = false])
Importante
Use of the
$upper
parameter is deprecated. It will be removed in future releases.- Parámetros:
$upper (
bool
) – si se debe devolver el nombre del método de solicitud en mayúsculas o minúsculas
- Devuelve:
método de solicitud HTTP
- Tipo del valor devuelto:
cadena
Devuelve
$_SERVER['REQUEST_METHOD']
, con la opción de configurarlo en mayúsculas o minúsculas.<?php echo $request->getMethod(true); // Outputs: POST echo $request->getMethod(false); // Outputs: post echo $request->getMethod(); // Outputs: post
- setMethod($method)
Obsoleto desde la versión 7.0.5: Utilice
Higgs\HTTP\Request::withMethod()
en su lugar.- Parámetros:
$método (
string
) – establece el método de solicitud. Se utiliza al falsificar la solicitud.
- Devuelve:
Esta solicitud
- Tipo del valor devuelto:
Solicitud
- withMethod($method)
Nuevo en la versión 7.0.5.
- Parámetros:
$método (
string
) – establece el método de solicitud.
- Vuelve:
Nueva instancia de solicitud
- Tipo del valor devuelto:
Solicitud
- getServer([$index = null[, $filter = null[, $flags = null]]])
- Parámetros:
$index (
mixed
) – nombre del valor$filter (
int
) – El tipo de filtro a aplicar. Puede encontrar una lista de filtros en el Manual de PHP<https://www.php.net/manual/en/filter.filters.php> __.$flags (
int|array
) – Banderas a aplicar. Se puede encontrar una lista de banderas en el Manual de PHP<https://www.php.net/manual/en/filter.filters.flags.php> __.
- Devuelve:
valor del elemento
$_SERVER
si se encuentra, nulo si no- Tipo del valor devuelto:
mixto
Este método es idéntico a los métodos
getPost()
,getGet()
ygetCookie()
del Clase IncomingRequest, solo recupera datos del servidor ($_SERVER
):<?php $request->getServer('some_data');
Para devolver una matriz de múltiples valores
$_SERVER
, pase todas las claves requeridas como una matriz.<?php $request->getServer(['SERVER_PROTOCOL', 'REQUEST_URI']);
- getEnv([$index = null[, $filter = null[, $flags = null]]])
Obsoleto desde la versión 4.4.4: This method does not work from the beginning. Use
env()
en su lugar.- Parámetros:
$index (
mixed
) – nombre del valor$filter (
int
) – El tipo de filtro a aplicar. Puede encontrar una lista de filtros en el Manual de PHP<https://www.php.net/manual/en/filter.filters.php> __.$flags (
int|array
) – Banderas a aplicar. Se puede encontrar una lista de banderas en el Manual de PHP<https://www.php.net/manual/en/filter.filters.flags.php> __.
- Devuelve:
valor del elemento
$_ENV
si se encuentra, nulo si no- Tipo del valor devuelto:
mixto
Este método es idéntico a los métodos
getPost()
,getGet()
ygetCookie()
del Clase IncomingRequest, solo recupera datos ambientales ($_ENV
):<?php $request->getEnv('some_data');
Para devolver una matriz de múltiples valores
$_ENV
, pase todas las claves requeridas como una matriz.<?php $request->getEnv(['HIGGS_ENVIRONMENT', 'S3_BUCKET']);
- setGlobal($method, $value)
- Parámetros:
$método (
string
) – nombre del método$valor (
mixed
) – Datos a agregar
- Devuelve:
Esta solicitud
- Tipo del valor devuelto:
Solicitud
Permite configurar manualmente el valor de PHP global, como
$_GET
,$_POST
, etc.
- fetchGlobal($method[, $index = null[, $filter = null[, $flags = null]]])
- Parámetros:
$método (
string
) – constante de filtro de entrada$index (
mixed
) – nombre del valor$filter (
int
) – El tipo de filtro a aplicar. Puede encontrar una lista de filtros en el manual de PHP<https://www.php.net/manual/en/filter.filters.php> __.$flags (
int|array
) – Banderas a aplicar. Se puede encontrar una lista de banderas en el Manual de PHP<https://www.php.net/manual/en/filter.filters.flags.php> __.
- Tipo del valor devuelto:
mixto
Obtiene uno o más elementos de un global, como cookies, get, post, etc. Opcionalmente, puede filtrar la entrada cuando la recupera pasando un filtro.