PHP Luminova: Custom Content Responses in Controllers

The View Response class simplifies the rendering of content within your application's controller methods or routing closures. Unlike the template View class, this class allows you to render content directly without additional processing, giving you complete control over the output.

This is suitable to use in responding APIs content without an addition overhead in processing the contents.

Key Features:

• Direct Rendering: Easily render content within your application's controllers or routes without reprocessing.
• Global Access: Use the global procedural function to access the class instance without explicit instantiation.

Limitations:

• No View Caching: This method does not support view caching. Implement custom caching if needed.
• No Template Support: This class does not support the use of Smarty or Twig templates.

• Class namespace: \Luminova\Template\Response

Usages

Helper Function Initialization

The global helper of Response class will return a shared instance of response class.

<?php
$response = response(200);

Initialize class directly.

<?php 
use \Luminova\Template\Response;

$response = new Response(200);

To output json content.

<?php 
$response->json([
    'message' => 'Foo bar'
]);

To output html content.

<?php 
$response->html('<p>Foo bar</p>');

To output file content in browser.

<?php 
$response->stream('/path/to/file/', 'large-pdf.pdf', [
    'Content-Type' => 'application/pdf'
], true, 3600);

To download file from browser.

<?php 
$response->download('/path/to/file/document.pdf', 'large-pdf.pdf', [
    'Content-Type' => 'application/pdf'
]);

To download content from browser.

<?php 
$response->download('Hello world!', 'hello.txt', [
    'Content-Type' => 'text/plain'
]);

Methods

constructor

Initialize response class constructor with HTTP status code and optional headers.

<?php 
function __construct(
    private int $status = 200, 
    private array $headers = [],
    private bool $encode = false,
    private bool $minifyCodeblocks = false,
    private bool $codeblockButton = false
)

Parameters:

getStatusCode

Get the current HTTP status code.

public getStatusCode(): int

Return Value:

int - Return the current HTTP status code.

getHeaders

Retrieve all HTTP headers.

public getHeaders(): array<string,mixed>

Return Value:

array<string,mixed> - Return list of all HTTP headers.

getHeader

Retrieve a specific HTTP header.

public getHeader(string $name): mixed

Parameters:

Return Value:

mixed - Return the header value, or null if it doesn't exist.

getProtocolVersion

Retrieves the HTTP protocol version (e.g, 1.0, 1.1).

public getProtocolVersion(): float

Return Value:

float - Return the HTTP protocol version.

clearHeaders

Clear all previous HTTP headers.

public clearHeaders(): void

clearRedirects

Clear previous set HTTP header redirects.

public clearRedirects(): bool

Return Value:

bool - Return true if any redirect was cleared, false otherwise.

hasRedirects

Determine if the response headers has any redirects.

public hasRedirects(): bool

Return Value:

bool - Return true if headers contain any redirect, otherwise false.

setStatus

Set the HTTP status code using setStatus method.

public setStatus(int $status = 200): self

Parameters:

Return Value:

Response - Return response class instance.

encode

Set enable or disable content encoding, otherwise it will use default flag in env file enable.encoding

public encode(bool $encode): self

Parameters:

Return Value:

Response - Return response class instance.

minify

Set enable or disable content minification, otherwise it will use default flag in env file page.minification.

public minify(bool $minify): self

Parameters:

Return Value:

Response - Return response class instance.

codeblock

Set if HTML codeblock tags should be ignore during content minification.For this to work correctly minification of content must be enabled either by calling method minify or enabling minification in env file.

public codeblock(bool $minify, bool $button = false): self 

Parameters:

Return Value:

Response - Return response class instance.

header

Set response header to use.

public header(string $key, mixed $value): self 

Parameters:

Return Value:

Response - Return response class instance.

headers

Set response headers to use.

public headers(array<string,mixed> $headers): self 

Parameters:

Return Value:

Response - Return response class instance.

send

Send HTTP response headers to the client.This method sends the HTTP status code (if set) and all accumulated headers to the client.

public send(): void 

render

Render any content format anywhere with your own customizations.Using this method allows you to pass encode or minify without using the default from env.

public render(mixed $content, int $status = 200, array $headers = [],  bool $encode = false, bool $minify = false): int

Parameters:

Return Value:

int - Return status code success as STATUS_SUCCESS, otherwise failure as STATUS_ERROR.

Note: The default content type is application/json if non was provided in $headers.

json

Send a JSON response.

public json(array|object $content): int

Parameters:

Return Value:

int - Return status code success, otherwise failure.

text

Send a plain text response.

public text(string $content): int

Parameters:

Return Value:

int - Return status code success, otherwise failure.

html

Send an HTML response.

public html(string $content): int

Parameters:

Return Value:

int - Return status code success, otherwise failure.

xml

Send an XML response.

public xml(string $content): int

Parameters:

Return Value:

int - Return status code success, otherwise failure.

download

Download file from server or download response string content.

public download(string $fileOrContent, ?string $name = null, array $headers = []): bool

Parameters:

Return Value:

bool - Return true if the download was successful, false otherwise.

stream

Streaming large files.This allows you to display any file on browser.

public stream(string $path, string $basename, array $headers = [], bool $eTag = true, int $expiry = 0): bool

Parameters:

Return Value:

bool - Return true if file streaming was successful, false otherwise.

redirect

Redirect the client to a different URL location with the appropriate status code (302, 303, or 307) .This method handles HTTP redirection by sending an appropriate Location or Refresh header and optionally specifying a status code. It auto-detects IIS environments and uses the refresh method for compatibility.

public redirect(string $uri, ?string $method = null, ?int $code = null): void

Parameters: