PHP Luminova: Custom Content Responses in Controllers
Response class allows you to render or download content without processing, which gives you full control over the output and processing of the content.
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
orTwig
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(int $status = 200, array<string,mixed> $headers = [])
Parameters:
Parameter | Type | Description |
---|---|---|
$status | int | HTTP status code (default: 200 OK). |
$headers | array<string,mixed> | The header key-pair (default: []). |
setStatus
Set the HTTP status code using setStatus method.
public setStatus(int $status = 200): self
Parameters:
Parameter | Type | Description |
---|---|---|
$status | int | HTTP status code (default: 200 OK) |
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:
Parameter | Type | Description |
---|---|---|
$encode | bool | Enable content encoding like gzip, deflate. |
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:
Parameter | Type | Description |
---|---|---|
$minify | bool | Enable content minification. |
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:
Parameter | Type | Description |
---|---|---|
$minify | bool | Indicate if codeblocks should be minified. |
$button | bool | Indicate if codeblock tags should include a copy button (default: false). |
Return Value:
Response
- Return response class instance.
header
Set response header to use.
public header(string $key, mixed $value): self
Parameters:
Parameter | Type | Description |
---|---|---|
$key | string | The header key. |
$value | mixed | The header value for key. |
Return Value:
Response
- Return response class instance.
headers
Set response headers to use.
public headers(array<string,mixed> $headers): self
Parameters:
Parameter | Type | Description |
---|---|---|
$headers | array<string,mixed> | The headers key-pair. |
Return Value:
Response
- Return response class instance.
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:
Parameter | Type | Description |
---|---|---|
$content | mixed | The content to render. |
$status | int | The HTTP status code (default: 200 OK). |
$headers | array | Additional output headers. |
$encode | bool | Weather to enable content encoding like gzip (default: false). |
$minify | bool | Weather to minify content (default: false). |
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:
Parameter | Type | Description |
---|---|---|
$content | array|object | The array or json object to be rendered as JSON. |
Return Value:
int
- Return status code success, otherwise failure.
text
Send a plain text response.
public text(string $content): int
Parameters:
Parameter | Type | Description |
---|---|---|
$content | string | The plain text content to render. |
Return Value:
int
- Return status code success, otherwise failure.
html
Send an HTML response.
public html(string $content): int
Parameters:
Parameter | Type | Description |
---|---|---|
$content | string | The HTML content to render. |
Return Value:
int
- Return status code success, otherwise failure.
xml
Send an XML response.
public xml(string $content): int
Parameters:
Parameter | Type | Description |
---|---|---|
$content | string | The XML content to render. |
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:
Parameter | Type | Description |
---|---|---|
$path | string | Path to the file or content to be downloaded. |
$name | string|null | Optional name to be used for the downloaded file. |
$headers | array | Optional download headers. |
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:
Parameter | Type | Description |
---|---|---|
$path | string | The path to file storage (e.g: /writeable/storages/images/ ). |
$name | string | The file name (e.g: image.png). |
$headers | array | Optional stream output headers. |
$eTag | bool | Whether to generate ETag headers (default: true). |
$expiry | int | Expiry time in seconds for cache control (default: 0), indicating no cache. |
Return Value:
bool
- Return true if file streaming was successful, false otherwise.
redirect
Redirect to a another URL
location.
public redirect(string $url = '/', int $response_code): void
Parameters:
Parameter | Type | Description |
---|---|---|
$url | string | URL location to redirect. |
$response_code | int | Response status code. |