Request

The Request class wraps PSR-7's RequestInterface to provide simplified access to HTTP request data. It handles automatic body parsing, header inspection, content type detection, and query parameter management. The class implements ArrayAccess for read-only array-style data access and uses the Macroable trait for runtime extension.

Related Pages: See PendingRequest for request building and configuration, and Response for response handling.

Primary Source: src/Request.php1-279

Class Overview

The Request class provides a simplified interface over PSR-7's RequestInterface for reading request data.

Core Capabilities:

• Access request metadata: method(), url(), body()
• Header inspection: headers(), header(), hasHeader(), hasHeaders()
• Content type detection: isForm(), isJson(), isMultipart()
• Automatic body parsing: data() for form/JSON payloads
• Query parameter access: query(), withQuery(), withoutQuery()
• Multipart file validation: hasFile()
• Array-style access via ArrayAccess (read-only)

Key Characteristics:

Characteristic	Implementation
Wrapped Class	Psr\Http\Message\RequestInterface
Implements	ArrayAccess
Trait	Hyperf\Macroable\Macroable
Mutability	Immutable (array access is read-only, query methods return new instances)
Data Parsing	Lazy-loaded and cached in $data property

Sources: src/Request.php14-28

Class Structure and Dependencies

Diagram: Request Class Architecture

Sources: src/Request.php1-279

Request Metadata Access

The Request class provides simple methods for retrieving basic request information:

HTTP Method

Returns the HTTP method (GET, POST, PUT, DELETE, etc.) from the underlying PSR-7 request.

Sources: src/Request.php33-36

Request URL

Returns the full URL of the request as a string by casting the PSR-7 URI object.

Sources: src/Request.php41-44

Body Content

Returns the raw body content of the request as a string.

Sources: src/Request.php103-106

Header Access and Validation

The Request class provides multiple methods for working with HTTP headers:

Method	Purpose	Return Type
hasHeader($key, $value = null)	Check if header exists, optionally with specific value(s)	bool
hasHeaders($headers)	Check multiple headers at once	bool
header($key)	Get all values for a specific header	array
headers()	Get all request headers	array

Header Checking Logic

Implementation Details:

• src/Request.php49-64 - hasHeader() checks for presence or specific values
• src/Request.php69-82 - hasHeaders() validates multiple headers
• src/Request.php87-90 - header() uses Arr::get() for safe access
• src/Request.php95-98 - headers() returns all headers from PSR-7 request

Sources: src/Request.php49-98

Content Type Detection

The Request class provides three methods for detecting request body content types based on the Content-Type header:

Content Type Detection Methods

Method	Detects	Implementation
isForm()	application/x-www-form-urlencoded	Exact match on Content-Type header
isJson()	JSON content types	Substring match for "json" in Content-Type
isMultipart()	multipart/form-data	Substring match for "multipart" in Content-Type

Sources: src/Request.php168-189

Diagram: Content Type Detection Logic

Sources: src/Request.php168-189

Data Extraction and Body Parsing

The Request class provides intelligent data extraction that automatically parses request bodies based on content type:

Diagram: data() Method Decision Flow

Methods and Behavior

Method	Visibility	Purpose	Caching
data()	public	Returns decoded form/JSON data	Via parameters() or json()
parameters()	protected	Parses form-encoded body	Cached in $data property
json()	protected	Parses JSON body	Cached in $data property
withData($data)	public	Manually set decoded data	Sets $data property

Implementation Notes:

• src/Request.php127-137 - data() determines format and delegates
• src/Request.php142-151 - parameters() uses parse_str() with caching
• src/Request.php156-163 - json() uses json_decode() with caching
• src/Request.php194-199 - withData() allows manual data injection

Sources: src/Request.php127-199

Query Parameter Management

The Request class provides methods for inspecting and manipulating URL query parameters:

Query Parameter Methods

Method	Operation	Return	Mutates Request
query()	Parses and returns query parameters	array	No
withQuery($query)	Merges parameters into query string	New Request	Immutable (returns new)
withoutQuery($keys)	Removes specified parameters	New Request	Immutable (returns new)

Diagram: Query Parameter Methods

Sources: src/Request.php201-226

Multipart File Validation

For multipart requests, the Request class provides file validation:

Validation Logic:

1. Checks if request is multipart via isMultipart()
2. Searches $data array for matching file entries
3. Optionally matches file contents and filename

Filter Criteria:

Parameter	Purpose	Optional
$name	File input field name	No
$value	Expected file contents	Yes
$filename	Expected filename	Yes

Sources: src/Request.php111-122

ArrayAccess Implementation

The Request class implements ArrayAccess to provide array-style access to request data. The implementation is read-only: write operations throw LogicException.

Diagram: ArrayAccess Methods

Behavior Summary

Operation	Method	Behavior
Read check	isset($request['key'])	Checks if key exists in data()
Read access	$request['key']	Returns value from data() array
Write	$request['key'] = $value	Throws LogicException
Unset	unset($request['key'])	Throws LogicException

Important: The ArrayAccess implementation is read-only. Attempts to modify data throw exceptions with the message: "Request data may not be mutated using array access."

Sources: src/Request.php237-278

PSR-7 Interoperability

The Request class maintains full compatibility with PSR-7 standards:

This method provides direct access to the underlying PSR-7 RequestInterface object, allowing integration with other PSR-7 compatible libraries and tools.

Use Cases:

• Passing requests to PSR-7 middleware
• Integration with PSR-15 request handlers
• Compatibility with PSR-18 HTTP clients
• Custom request transformations

Sources: src/Request.php231-234

Runtime Extension with Macros

The Request class uses the Macroable trait from hyperf/macroable, allowing custom methods to be added at runtime:

This enables developers to extend Request functionality without modifying the class itself. For more information about using macros, see Runtime Extension with Macros.

Sources: src/Request.php16

Complete Method Reference

Core Data Access

Method	Return Type	Purpose
method()	string	Get HTTP method
url()	string	Get full URL
body()	string	Get raw body content
data()	array	Get parsed form/JSON data

Header Methods

Method	Return Type	Purpose
header($key)	array	Get specific header values
headers()	array	Get all headers
hasHeader($key, $value)	bool	Check header existence/value
hasHeaders($headers)	bool	Check multiple headers

Content Type Detection

Method	Return Type	Purpose
isForm()	bool	Check if form-encoded
isJson()	bool	Check if JSON
isMultipart()	bool	Check if multipart

Query Parameters

Method	Return Type	Purpose
query()	array	Get query parameters
withQuery($query)	Request	Add/merge query parameters
withoutQuery($keys)	Request	Remove query parameters

File Handling

Method	Return Type	Purpose
hasFile($name, $value, $filename)	bool	Check for multipart file

Data Management

Method	Return Type	Purpose
withData($data)	Request	Set decoded data manually

PSR-7 Compatibility

Method	Return Type	Purpose
toPsrRequest()	RequestInterface	Get underlying PSR-7 request

Sources: src/Request.php1-279