PHP Trait Flugg\Responder\Traits\RespondsWithJson

Author: Alexander Tømmerås ([email protected])
Datei anzeigen Open project: flugger/laravel-responder

Public Methods

Method Description
errorResponse ( string $errorCode = null, integer $statusCode = null, mixed $message = null ) : Illuminate\Http\JsonResponse Generate an error JSON response.
successResponse ( mixed | null $data = null, integer | null $statusCode = null, array $meta = [] ) : Illuminate\Http\JsonResponse Generate a successful JSON response.
transform ( mixed | null $data = null, callable | string | null $transformer = null ) : SuccessResponseBuilder Transform the data and return a success response builder.

Method Details

errorResponse() public method

Generate an error JSON response.
public errorResponse ( string $errorCode = null, integer $statusCode = null, mixed $message = null ) : Illuminate\Http\JsonResponse
$errorCode string
$statusCode integer
$message mixed
return Illuminate\Http\JsonResponse

successResponse() public method

Generate a successful JSON response.
public successResponse ( mixed | null $data = null, integer | null $statusCode = null, array $meta = [] ) : Illuminate\Http\JsonResponse
$data mixed | null
$statusCode integer | null
$meta array
return Illuminate\Http\JsonResponse

transform() public method

Transform the data and return a success response builder.
public transform ( mixed | null $data = null, callable | string | null $transformer = null ) : SuccessResponseBuilder
$data mixed | null
$transformer callable | string | null
return Flugg\Responder\Http\SuccessResponseBuilder