PHP Luminova: HTTP Response Message Object

The HTTP Response object in Luminova represents the result of a network request made through the Novio or Guzzle client. It gives you easy access to everything that comes back from the server, the status code, response headers, body content, and other useful details. This makes it simple to inspect, debug, or process any HTTP response your application receives.

Class Definition

• Class namespace: Luminova\Http\Message\Response
• This class implements: \Psr\Http\Message\ResponseInterface, \Stringable

Methods

constructor

Creates a new HTTP response object.

public __construct(
   \Psr\Http\Message\StreamInterface|string $body = '',
   int $statusCode = 200, 
   array<string,mixed> $headers = [], 
   array<string,mixed> $info = [],
   string $reasonPhrase = 'OK',
   string $protocolVersion = '1.1',
   ?Luminova\Interface\CookieJarInterface $cookie = null
)

Parameters:

toString

Convert the HTTP response to a formatted string.

This method generates the complete HTTP response string, including the status line, headers, and body content. It checks for the 'Content-Length' header and adds it if not present.

public toString(): string

Return Value:

string - Return the complete HTTP response as a string.

getProtocolVersion

Retrieves the HTTP protocol version (e.g., 1.0, 1.1). Returns an empty string if not set.

public getProtocolVersion(): string

Return Value:

string - The HTTP protocol version.

getReasonPhrase

Retrieves the reason phrase associated with the HTTP status code (e.g., OK, Internal Server Error).

public getReasonPhrase(): string

Return Value:

string - Returns the HTTP message phrase.

getStatusCode

Retrieves the HTTP status code of the response.

public getStatusCode(): int

Return Value:

int - Returns the HTTP status code.

getLength

Retrieves the request response contents length.

public getLength(): int

Return Value:

int - Returns the content length.

getFileTime

Retrieves the file modified time for the request.

public getFileTime(): int

Return Value:

int - Returns the file modified time if available; otherwise, returns -1.

getHeaders

Retrieves all response headers.

public getHeaders(): array<string,array>

Return Value:

array - Returns an associative array of response headers.

getHeader

Retrieves a specific header value by its key.

public getHeader(string $name): array<int,mixed>

Parameters:

Return Value:

array - Returns an array of header values.

getHeadersString

Convert an associative array of headers into a formatted string.This method converts the response headers to a string representation suitable for HTTP responses, where each header is formatted as key: value\r\n and separated by CRLF Carriage Return (ASCII 13, \r ) Line Feed (ASCII 10, \n).

public getHeadersString(): string

Return Value:

string - Return a formatted string containing all headers, followed by an additional CRLF to signal the end of the headers section.

getHeaderLine

Retrieves a comma-separated string of values for a specific header.

public getHeaderLine(string $header): string

Parameters:

Return Value:

string - Returns a string of concatenated values for the given header.

hasHeader

Checks if a specific header exists in the response.

public hasHeader(string $name): bool

Parameters:

Return Value:

bool - Returns true if the header exists, false otherwise.

getBody

Retrieves the response body as a stream. This method opens a temporary stream, writes the response contents if available (and if not already a stream), and then rewinds the stream before returning it.

public getBody(): StreamInterface

Return Value:

Luminova\Utility\Storage\Stream<StreamInterface> - The response body as a stream object.

Throws:

• Luminova\Exceptions\RuntimeException - If the temporary stream cannot be opened.

See Also:

For more information on stream management, refer to the Stream Documentation here.

getContents

Retrieves the extracted response contents as a string. Use this only for non-stream request responses.

public getContents(): string

Return Value:

string - Returns the processed response contents.

getInfo

Retrieves additional information about the response.

public getInfo(): array<string,mixed>

Return Value:

array - Returns an associative array of response metadata.

withHeader

Returns a new instance with the specified header value replacing the existing one.

public withHeader(string $name, string|string[] $value): ResponseInterface

Parameters:

Return Value:

ResponseInterface - A new response object with the updated header.

Throws:

• Luminova\Exceptions\InvalidArgumentException - If the header name or value is invalid.

withoutHeader

Returns a new instance without the specified header.

public withoutHeader(string $name): ResponseInterface

Parameters:

Return Value:

ResponseInterface - Returns a new response object without the specified header.

withStatus

Returns a new instance with the specified status code and optional reason phrase.

public withStatus(int $code, string $reasonPhrase = ''): ResponseInterface

Parameters:

Return Value:

ResponseInterface - A new response object with the specified status.

Throws:

• Luminova\Exceptions\InvalidArgumentException - If the status code is invalid.

withProtocolVersion

Returns a new instance with the specified HTTP protocol version.

public withProtocolVersion(string $version): ResponseInterface

Parameters:

Return Value:

ResponseInterface - A new response object with the specified protocol version.