ResponseHelper
in package
Helper for standardized API/AJAX responses.
Table of Contents
Methods
- error() : array<string|int, mixed>
- Return an error JSON response.
- forbidden() : array<string|int, mixed>
- Return a forbidden response.
- notFound() : array<string|int, mixed>
- Return a not found response.
- outputJson() : void
- Output JSON response and exit (for standalone scripts).
- paginated() : array<string|int, mixed>
- Return a paginated response.
- success() : array<string|int, mixed>
- Return a success JSON response.
- toSymfonyResult() : string
- Build Symfony action result for JSON response.
- unauthorized() : array<string|int, mixed>
- Return an unauthorized response.
- validationError() : array<string|int, mixed>
- Return a validation error response.
Methods
error()
Return an error JSON response.
public
static error(string $message[, int $code = 400 ][, mixed $errors = null ]) : array<string|int, mixed>
Parameters
- $message : string
- $code : int = 400
- $errors : mixed = null
Return values
array<string|int, mixed>forbidden()
Return a forbidden response.
public
static forbidden([string $message = 'Forbidden' ]) : array<string|int, mixed>
Parameters
- $message : string = 'Forbidden'
Return values
array<string|int, mixed>notFound()
Return a not found response.
public
static notFound([string $resource = 'Resource' ]) : array<string|int, mixed>
Parameters
- $resource : string = 'Resource'
Return values
array<string|int, mixed>outputJson()
Output JSON response and exit (for standalone scripts).
public
static outputJson(mixed $data[, int $statusCode = 200 ]) : void
Parameters
- $data : mixed
- $statusCode : int = 200
paginated()
Return a paginated response.
public
static paginated(iterable<string|int, mixed> $items, int $total, int $page, int $perPage[, string|null $message = null ]) : array<string|int, mixed>
Parameters
- $items : iterable<string|int, mixed>
- $total : int
- $page : int
- $perPage : int
- $message : string|null = null
Return values
array<string|int, mixed>success()
Return a success JSON response.
public
static success([mixed $data = null ][, string $message = 'Success' ]) : array<string|int, mixed>
Parameters
- $data : mixed = null
- $message : string = 'Success'
Return values
array<string|int, mixed>toSymfonyResult()
Build Symfony action result for JSON response.
public
static toSymfonyResult(array<string|int, mixed> $response) : string
Parameters
- $response : array<string|int, mixed>
Return values
stringunauthorized()
Return an unauthorized response.
public
static unauthorized([string $message = 'Unauthorized' ]) : array<string|int, mixed>
Parameters
- $message : string = 'Unauthorized'
Return values
array<string|int, mixed>validationError()
Return a validation error response.
public
static validationError(array<string|int, mixed> $errors) : array<string|int, mixed>
Parameters
- $errors : array<string|int, mixed>