PHP 클래스 Flugg\Responder\Http\ErrorResponseBuilder

저자: Alexander Tømmerås ([email protected])
상속: extends ResponseBuilder
파일 보기 프로젝트 열기: flugger/laravel-responder 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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