PHP Luminova: Management of Incoming HTTP Request Headers

The Header class in Luminova is designed to manage HTTP request headers in a structured and efficient manner, similar to the way the Server class handles server-related data. It provides methods to interact with, retrieve, and manipulate request headers, simplifying the process of managing HTTP requests.

Class Definition

• Class namespace: \Luminova\Http\Header
• This class implements: \Luminova\Interface\LazyInterface, \Countable

Example Usage:

The Header object is available in the Request class object as a public property $request->header.

Get the value for a specific key:

<?php
$value = $header->get('User-Agent');

Set a new value for a key:

<?php
$header->set('User-Agent', 'New User Agent');

Remove a key:

<?php
$header->remove('Accept');

Search for a value:

<?php
$key = $header->search('Host');

Check if a key exists:

<?php
if ($header->has('Accept-Encoding')) {
    // Key exists
}

Count the number of elements:

<?php
$count = $header->count();

Methods

constructor

Initializes the Header object with optional headers. If no headers are passed, it will use the request headers.

public __construct(?array $variables = null): mixed

Parameters:

get

Retrieves the value of a specific header or all headers if no name is provided.

public get(string|null $name = null, mixed $default = null): mixed|array|string|null

Parameters:

Return Value:

mixed|array|string|null - Return the value of the specified header, or all headers if $name is null.

set

Sets the value for a specific header.

public set(string $key, mixed $value): void

Parameters:

remove

Removes a specific header by its key.

public remove(string $key): void

Parameters:

has

Checks if a specific header key exists.

public has(string $key): bool

Parameters:

Return Value:

bool - Return true if the key exists, false otherwise.

count

Gets the total number of header variables.

public count(): int

Return Value:

int - Return the number of header variables.

send

Sends HTTP headers to the client.

static function send(array $headers, bool $ifNotSent = true, bool $charset = false): void

Parameters:

sendStatus

Sends HTTP response status code if it is valid.

This method checks if the provided status code is within the valid HTTP status code rangebefore sending it using the http_response_code function. It also sets the REDIRECT_STATUS superglobal.

static function sendStatus(int $code): bool 

Parameters:

Return Value:

bool - Return true if status code is valid and set, false otherwise.

getHeaders

Extracts all request headers using apache_request_headers or the $_SERVER variables.

public static getHeaders(): array<string,string>

Return Value:

array<string,string> - Return the request headers.

getContentType

Determines the content type based on the file extension and charset.

public static getContentType(string $extension = 'html', string $charset = null): string

Parameters:

Return Value:

string - Return the content type and optional charset.

getContentTypes

Retrieves content types by name.

public static getContentTypes(string $type): array<string,array>

Parameters:

Return Value:

array<string,array> - Return array, string of content types or null if not found.