PHP Request library

Versión en español

PHP library for handling requests.

Requirements
Installation
Available Methods
Quick Start
Usage
Tests
Sponsor
License

Requirements

This library is supported by PHP 7.4.

IMPORTANT: Version 2.x does not support version 1.x of this library.

IMPORTANT: Version 1.x has been considered obsolete, but if you want to use it for 5.6 versions of PHP you can have a look at its documentation.

Installation

The preferred way to install this extension is through Composer.

To install PHP Request library, simply:

composer require josantonius/request

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

composer require josantonius/request --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/php-request.git

Or install it manually:

Download Request.php and Validate.php:

wget https://raw.githubusercontent.com/Josantonius/php-request/master/src/Request.php

wget https://raw.githubusercontent.com/Josantonius/php-validate/master/src/Validate.php

Available Methods

Available methods in this library:

- Check if it's a GET request

Request::isGet();

# Return (boolean)

- Check if it's a POST request

Request::isPost();

# Return (boolean)

- Check if it's a PUT request

Request::isPut();

# Return (boolean)

- Check if it's a DELETE request

Request::isDelete();

# Return (boolean)

- Get request params

For PUT and DELETE requests, the content type will be checked to correctly obtain the data received in the request.

The content types compatible with this library are:

application/atom+xml
text/html
text/plain
application/json
application/javascript
multipart/form-data
application/x-www-form-urlencoded

Request::input($type);

Attribute	Description	Type	Required	Default
$type	Request type.	string	Yes

# Return anonymous function that will return the Request object when it's called

- Data sanitation and return as array

asArray($filters, $default);

Attribute	Description	Type	Required	Default
$filters	Associative array with data type for each key. Fields that are not included in the filters will not be sanitized.	array	No	`[]`
$default	Default value. Null or the default value will be returned for fields that do not match with the data type indicated.	mixed	No	`null`

# Return (array) → it will return an empty array in case of error

- Data sanitation and return as object

asObject($filters, $default);

Attribute	Description	Type	Required	Default
$filters	Associative array with data type for each key. Fields that are not included in the filters will not be sanitized.	array	No	`[]`
$default	Default value. Null or the default value will be returned for fields that do not match with the data type indicated.	mixed	No	`null`

# Return (object) → it will return an empty object in case of error