PHP Класс Flugg\Responder\Http\ErrorResponseBuilder

Автор: Alexander Tømmerås ([email protected])
Наследование: extends ResponseBuilder
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$data array Optional error data appended with the response.
$errorCode string The error code used to identify the error.
$message string A descriptive error message explaining what went wrong.
$parameters array Any parameters used to build the error message.
$statusCode integer The HTTP status code for the response.
$translator Symfony\Component\Translation\TranslatorInterface Translator service used for translating stuff.

Открытые методы

Метод Описание
__construct ( Illuminate\Contracts\Routing\ResponseFactory | ResponseFactory $responseFactory, Symfony\Component\Translation\TranslatorInterface $translator ) Constructor.
addData ( array $data ) : ErrorResponseBuilder Add additonal data appended to the error object.
setError ( string $errorCode = null, string | array | null $message = null ) : ErrorResponseBuilder Set the error code and optionally an error message.
setStatus ( integer $statusCode ) : ResponseBuilder Set the HTTP status code for the response.
toArray ( ) : array Serialize the data and return as an array.

Защищенные методы

Метод Описание
buildErrorData ( ) : array | null Build the error object of the serialized response data.
resolveMessage ( ) : string | null Resolve an error message from the translator.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( Illuminate\Contracts\Routing\ResponseFactory | ResponseFactory $responseFactory, Symfony\Component\Translation\TranslatorInterface $translator )
$responseFactory Illuminate\Contracts\Routing\ResponseFactory | Laravel\Lumen\Http\ResponseFactory
$translator Symfony\Component\Translation\TranslatorInterface

addData() публичный Метод

Add additonal data appended to the error object.
public addData ( array $data ) : ErrorResponseBuilder
$data array
Результат ErrorResponseBuilder

buildErrorData() защищенный Метод

Build the error object of the serialized response data.
protected buildErrorData ( ) : array | null
Результат array | null

resolveMessage() защищенный Метод

Resolve an error message from the translator.
protected resolveMessage ( ) : string | null
Результат string | null

setError() публичный Метод

Set the error code and optionally an error message.
public setError ( string $errorCode = null, string | array | null $message = null ) : ErrorResponseBuilder
$errorCode string
$message string | array | null
Результат ErrorResponseBuilder

setStatus() публичный Метод

Set the HTTP status code for the response.
public setStatus ( integer $statusCode ) : ResponseBuilder
$statusCode integer
Результат ResponseBuilder

toArray() публичный Метод

Serialize the data and return as an array.
public toArray ( ) : array
Результат array

Описание свойств

$data защищенное свойство

Optional error data appended with the response.
protected array $data
Результат array

$errorCode защищенное свойство

The error code used to identify the error.
protected string $errorCode
Результат string

$message защищенное свойство

A descriptive error message explaining what went wrong.
protected string $message
Результат string

$parameters защищенное свойство

Any parameters used to build the error message.
protected array $parameters
Результат array

$statusCode защищенное свойство

The HTTP status code for the response.
protected int $statusCode
Результат integer

$translator защищенное свойство

Translator service used for translating stuff.
protected TranslatorInterface,Symfony\Component\Translation $translator
Результат Symfony\Component\Translation\TranslatorInterface