PHP Luminova: Incoming HTTP Request Management Class

The Request class represents an incoming HTTP request to a server, encapsulating various components such as headers, query parameters, form data, and uploaded files. This class offers a structured approach to access and manipulate incoming HTTP requests, including built-in authentication mechanisms to validate requests based on origin, proxies, or allowed domains.

Accessing the Request Object

The request object can be accessed in multiple ways, depending on the context. You can use the global helper function, the Factory class, or the Controller class.

Access Methods

1. Using Global Helper Function

$request = request();

2. Accessing Through the Factory Class

use Luminova\Application\Factory;

$request = Factory::request();

3. Initializing the Request Instance Directly

use Luminova\Http\Request;

$request = new Request();

4. Accessing in Controller Classes

If your controller extends BaseController:

$this->request->foo();

If your controller extends BaseViewController, you can access it in two ways:

Direct Access:

$this->request()->foo();

Initializing in the onCreate Method:

You can initialize the request instance once, then access it later:

$this->request(); // Initialize

// Then access it.
$this->request->foo();

Properties

server

Http server instance.

public ?\Luminova\Http\Server $server = null;

header

Http request header instance.

public ?\Luminova\Http\Header $header = null;

agent

Browser request user-agent information.

public ?\Luminova\Http\UserAgent $agent = null;

Methods

constructor

Initializes a new Request object, representing an HTTP request.

This constructor optionally accept request properties like method, URI, body, files, raw body, server variables, and headers. allowing you to create a custom HTTP request.

public function __construct(
    private ?string $method = null,
    private ?string $uri = null,
    private array $body = [],
    private array $files = [],
    private ?string $raw = null,
    ?array $server = null,
    ?array $headers = null
)

Parameters:

Example

Create a new request-response object by passing appropriate values.

$request = new Luminova\Http\Request(
    method: 'POST',
    uri: '/api/v1/users',
    body: ['name' => 'John Doe', 'email' => '[email protected]'], 
    files: [
        'image' => [
            'name' => 'profile.jpg',
            'type' => 'image/jpeg',
            'tmp_name' => '/tmp/phpYzdqkD',
            'error' => 0,
            'size' => 123456
        ]
    ],
    raw: null,
    server: [
        'REQUEST_METHOD' => 'POST',
        'REMOTE_ADDR' => '192.168.1.10',
        'HTTP_USER_AGENT' => 'Mozilla/5.0',
        'SERVER_PROTOCOL' => 'HTTP/1.1',
        'SERVER_NAME' => 'example.com',
        'REQUEST_URI' => '/api/v1/users',
    ],
    headers: [
        'Content-Type' => 'application/json',
        'Authorization' => 'Bearer some-token',
        'Accept' => 'application/json',
        'X-Custom-Header' => 'CustomValue'
    ] 
);

toString

Converts the request body to a raw string format based on the content type.

public toString(): string

Return Value:

string - Return the raw string representation of the request body.

Supported Content Types:

• application/x-www-form-urlencoded: Converts the body to a URL-encoded query string.
• application/json: Converts the body to a JSON string.
• multipart/form-data: Converts the body to a multipart/form-data format.

toMultipart

Converts the request body to a multipart/form-data string format.

public toMultipart(): string

Return Value:

string - Return the multipart form-data representation of the request body.

setField

Set a specific field in the request body for the given HTTP method.

public setField(string $field, mixed $value, ?string $method = null): self

Parameters:

Return Value:

self - Returns the instance request class.

getGet

Get a field value from HTTP GET request method or entire fields if $field parameter is null.

public getGet(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getPost

Get a field value from HTTP POST request method or entire fields if $field parameter is null.

public getPost(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getPut

Get a value from the PUT request or entire fields if $field parameter is null.

public getPut(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getOptions

Get a value from the OPTIONS request or entire fields if $field parameter is null.

public getOptions(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getPatch

Get a value from the PATCH request method or entire fields if $field parameter is null.

public getPatch(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getHead

Get a value from the HEAD request method or entire fields if $field parameter is null.

public getHead(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getConnect

Get a value from the CONNECT request method or entire fields if $field parameter is null.

public getConnect(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getTrace

Get a value from the TRACE request method or entire fields if $field parameter is null.

public getTrace(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getPropfind

Get a value from the PROPFIND request method or entire fields if $field parameter is null.

public getPropfind(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getMkcol

Get a value from the MKCOL request method or entire fields if $field parameter is null.

public getMkcol(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getCopy

Get a value from the COPY request method or entire fields if $field parameter is null.

public getCopy(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getMove

Get a value from the MOVE request method or entire fields if $field parameter is null.

public getMove(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getLock

Get a value from the LOCK request method or entire fields if $field parameter is null.

public getLock(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getUnlock

Get a value from the UNLOCK request method or entire fields if $field parameter is null.

public getUnlock(string|null $field, mixed $default = null): mixed

Parameters:

Return Value:

mixed - Return the value from HTTP request method body based on field name.

getArray

Get a value from the request body as an array.

public getArray(string $field, array $default = [], ?string $method = null): array

Parameters:

Return Value:

array - Return array of HTTP request method key values.

getBody

Get the entire request body as an Array or JSON object.

public getBody(bool $object = false): array|object

Parameters:

Return Value:

array<string,mixed>|object - Return the request body as an array or json object.

getFile

Get an uploaded file instance or any generator yielding file instances for multiple files.

public getFile(string $name, ?int $index = null): Generator<int, File>|File|null

Parameters:

Return Value:

Generator<int, \Luminova\Http\File>|\Luminova\Http\File|null - Return uploaded File instance, a generator yielding File instances. or null if input name was not found.

See Also:

To learn more about File Upload Object, refer to the documentation.

Process File Object:

Handle file upload based on multiple files or single file.

<?php
use Luminova\Storages\Uploader;
use Luminova\Http\File;
use \Generator;

$images = $request->getFiles('images');
$config = [
    'upload_path' => root('writeable/storages/foo/'),
    'if_existed' => File::IF_EXIST_OVERWRITE
];

if ($images instanceof Generator) {
    foreach ($images as $index => $image) {
        if($image->valid()){
            $image->setConfig($config);
            $status = Uploader::upload($image);
        }
    }
}else if ($images instanceof File) {
    if($images->valid()){
        $images->setConfig($config);
        $status = Uploader::upload($images);
    }
}

getFiles

Get raw array of original uploaded file information without any modification.

public getFiles(): array

Return Value:

array<string,array> - Return an array containing uploaded files information.

Array Structure for Multiple File Uploads

[
    'images' => [
        'name'      => ['file1.jpg', 'file2.png', 'file3.gif'],
        'type'      => ['image/jpeg', 'image/png', 'image/gif'],
        'tmp_name'  => ['/tmp/phpYzdqkD', '/tmp/phpeEwEWq', '/tmp/php7sdfXy'],
        'error'     => [0, 0, 0],
        'size'      => [123456, 234567, 345678]
    ]
];

Also Support Flat File Structure:

[
    'images' => [
        [
            'name' => 'file1.jpg',
            'type' => 'image/jpeg',
            'tmp_name' => '/tmp/phpYzdqkD',
            'error' => 0,
            'size' => 123456
        ],
        [
            'name' => 'file2.png',
            'type' => 'image/png',
            'tmp_name' => '/tmp/phpeEwEWq',
            'error' => 0,
            'size' => 234567
        ],
        [
            'name' => 'file3.gif',
            'type' => 'image/gif',
            'tmp_name' => '/tmp/php7sdfXy',
            'error' => 0,
            'size' => 345678
        ]
    ]
];

Note: This structure may be developer-friendly, but it isn't the standard way PHP handles uploaded files.

getMethod

Get the current request method.

public getMethod(): string

Return Value:

string - Return the HTTP request method.

getBoundary

Extract the boundary from the Content-Type header.

public getBoundary(): ?string

Return Value:

string|null - Returns the boundary string or null if not found.

getFromMultipart

Parses a multipart/form-data string into an associative array with form fields and file data.

public getFromMultipart(string $data, string $boundary): array

Parameters:

Return Value:

array{param:array,files:array} - Return an array containing two keys params and files.

• params - Associative array of form field names and values
• files - Associative array of files with metadata and binary content

getContentType

Get the request content type.

public getContentType(): string

Return Value:

string - Return the request content type or blank string if not available.

getAuth

Get HTTP request header authorization from (e.g, HTTP_AUTHORIZATION, Authorization or REDIRECT_HTTP_AUTHORIZATION).

public getAuth(): ?string

Return Value:

string|null - Return the authorization header value or null if no authorization header was sent.

getQuery

Get the request URL query string.

public getQuery(): string

Return Value:

string - Return the request URL query parameters as string.

getQueries

Get current URL query parameters as an associative array using the parameter name as key.

public getQueries(): array<string,mixed>

Return Value:

array<string,mixed> - Return the request URL query parameters as an array.

getUrl

Get the full URL of the current request, including the scheme, host and query parameters. (e.g, https://example.com/foo/bar?query=123)

public getUrl(): string

Return Value:

string - Return the full URL of the request.

getUri

Get the URI (path and query string) of the current request (e.g, /foo/bar?query=123).

public getUri(): string

Return Value:

string - Return the URI of the request (path and query string).

getPaths

Get current request URL path information.

public getPaths(): string

Return Value:

string - Return the request URL paths.

getRequestUri

Returns un-decoded request URI, path and query string.

public getRequestUri(): string

Return Value:

string - Return the raw request URI (i.e. URI not decoded).

getHost

Get current request hostname without port, if allowed host is set it will check if host is in allowed list or patterns.

public getHost(bool $extension = false): string

Parameters:

Return Value:

string - Throw if host is invalid or not allowed.

Throws:

• \Luminova\Exceptions\SecurityException - Throw if host is invalid or not allowed.

getHostname

Get current request hostname with port if port is available.If allowed host is set it will check if host is in allowed list or patterns.

public getHostname(bool $extension = false, bool $port = true): string

Parameters:

Return Value:

string - Return request hostname and port.

Throws:

• \Luminova\Exceptions\SecurityException - If host is invalid or not allowed.

getOrigin

Get the request origin domain, if the list of trusted origin domains are specified, it will check if the origin is a trusted origin domain.

public getOrigin(): ?string

Return Value:

string|null - Return the request origin domain if found and trusted, otherwise null.

getPort

Get the request origin port from X_FORWARDED_PORT or SERVER_PORT if available.

public getPort(): int

Return Value:

int - Return the port number, otherwise default to 443 secured or 80 for insecure.

Check if X-Forwarded-Port header exists and use if available.If not available check for server-port header if also not available return default port.

getScheme

Gets the request scheme name.

public getScheme(): string

Return Value:

string - Return request scheme, if secured return https otherwise http.

getProtocol

Gets the request server protocol name and version (e.g: HTTP/1.1).

public getProtocol(string $default = 'HTTP/1.1'): string

Parameters:

Return Value:

string - Return Request protocol name and version, if available, otherwise default is return HTTP/1.1.

getBrowser

Get the request browser name and platform from user-agent information.

public getBrowser(): string

Return Value:

string - Return browser name and platform.

getUserAgent

Get request browser user-agent information.

public getUserAgent(?string $useragent = null): UserAgent

Parameters:

Return Value:

UserAgent - Return instance user-agent class containing browser information.

hasField

Check if a specific field exists in the request body for the given HTTP method.

public hasField(string $field, ?string $method = null): bool

Parameters:

Return Value:

bool - Returns true if the field exists for the given method; otherwise, false.

isGet

Check if the request method is GET.

public isGet(): bool

Return Value:

bool - Returns true if the request method is GET, false otherwise.

isPost

Check if the request method is POST.

public isPost(): bool

Return Value:

bool - Returns true if the request method is POST, false otherwise.

isMethod

Check if the request method is the provided method.

public isMethod(string $method = 'GET'): bool

Parameters:

Return Value:

bool - Returns true if the request method matches the provided method, false otherwise.

isAuth

Check if the Authorization header matches the specified type.

public isAuth(string $type = 'Bearer'): bool

Parameters:

Return Value:

bool - Returns true if the Authorization header matches the specified type, otherwise false.

Return Value:

bool - Return true if the request was made from the command line.

isSecure

Check if the current request connection is secure.

public isSecure(): bool

Return Value:

bool - Return true if the connection is secure false otherwise.

isProxy

Checks if the request is routed through a proxy server by inspecting various proxy-related headers.

public isProxy(): bool

Return Value:

bool - Returns true if the request is likely from proxy, false otherwise.

isAJAX

Check if request is ajax request, see if a request contains the HTTP_X_REQUESTED_WITH header.

public isAJAX(): bool

Return Value:

bool - Return true if request is ajax request, false otherwise

isApi

Check if the request URL indicates an API request endpoint.This method checks if the URL path prefix matched any of /api or public/api or your custom defined API URL prefix.

public isApi(): bool

Return Value:

bool - Returns true if the URL indicates an API endpoint, false otherwise.

isSameOrigin

Check if the request origin matches the current application host.

public isSameOrigin(bool $subdomains = false): bool

Parameters:

Return Value:

bool - Returns true if the request origin matches the current host, false otherwise.

isTrusted

Validates if the given (hostname, origin, proxy ip or subnet) matches any of the trusted patterns.

public static isTrusted(string $input, string $context = 'hostname'): bool

Parameters:

Return Value:

bool - Return true if the input is trusted, false otherwise.

Throws:

• \Luminova\Exceptions\InvalidArgumentException - If invalid context is provided.

Supported Context:

• hostname - Validates a host name.
• origin - Validates an origin hostname.
• proxy Validates an IP address or proxy.

Note: This will consider the defined configuration in App\Config\Security during validation.

isTrustedProxy

Check whether this request origin IP address is from a trusted proxy.

public isTrustedProxy(): bool

Return Value:

bool - Return true if the request origin IP address is trusted false otherwise.

isTrustedOrigin

Check whether this request origin is from a trusted origins.

public isTrustedOrigin(): bool

Return Value:

bool - Return true if the request origin is trusted false otherwise.