PHP Trait NilPortugues\Laravel5\JsonApi\Controller\JsonApiTrait

Exibir arquivo Open project: nilportugues/laravel5-jsonapi

Protected Properties

Property	Type	Description
$pageSize	integer
$serializer	NilPortugues\Laravel5\JsonApi\JsonApiSerializer

Public Methods

Method	Description
__construct ( NilPortugues\Laravel5\JsonApi\JsonApiSerializer $serializer )
getDataModel ( ) : Model	Returns an Eloquent Model.

Protected Methods

Method	Description
addHeaders ( Response $response ) : Response
createResourceCallable ( ) : callable	Reads the input and creates and saves a new Eloquent Model.
deleteResourceCallable ( $id ) : Closure
findResourceCallable ( $id ) : callable
listResourceCallable ( ) : callable	Returns a list of resources based on pagination criteria.
patchAction ( Illuminate\Http\Request $request, $id ) : Response
putAction ( Illuminate\Http\Request $request, $id ) : Response
totalAmountResourceCallable ( ) : callable	Returns the total number of results available for the current resource.
updateResourceCallable ( ) : callable
uriGenerator ( $controllerAction ) : mixed

Method Details

__construct() public method

public __construct ( NilPortugues\Laravel5\JsonApi\JsonApiSerializer $serializer )
$serializer	NilPortugues\Laravel5\JsonApi\JsonApiSerializer

addHeaders() protected method

protected addHeaders ( Response $response ) : Response
$response	Symfony\Component\HttpFoundation\Response
return	Symfony\Component\HttpFoundation\Response

createResourceCallable() protected method

Reads the input and creates and saves a new Eloquent Model.

protected createResourceCallable ( ) : callable
return	callable

deleteResourceCallable() protected method

protected deleteResourceCallable ( $id ) : Closure
$id
return	Closure

findResourceCallable() protected method

protected findResourceCallable ( $id ) : callable
$id
return	callable

getDataModel() abstract public method

Returns an Eloquent Model.

abstract public getDataModel ( ) : Model
return	Illuminate\Database\Eloquent\Model

listResourceCallable() protected method

Returns a list of resources based on pagination criteria.

protected listResourceCallable ( ) : callable
return	callable

patchAction() protected method

protected patchAction ( Illuminate\Http\Request $request, $id ) : Response
$request	Illuminate\Http\Request
$id
return	Symfony\Component\HttpFoundation\Response

putAction() protected method

protected putAction ( Illuminate\Http\Request $request, $id ) : Response
$request	Illuminate\Http\Request
$id
return	Symfony\Component\HttpFoundation\Response

totalAmountResourceCallable() protected method

Returns the total number of results available for the current resource.

protected totalAmountResourceCallable ( ) : callable
return	callable

updateResourceCallable() protected method

protected updateResourceCallable ( ) : callable
return	callable

uriGenerator() protected method

protected uriGenerator ( $controllerAction ) : mixed
$controllerAction
return	mixed

Property Details

$pageSize protected_oe property

protected int $pageSize
return	integer

$serializer protected_oe property

protected JsonApiSerializer,NilPortugues\Laravel5\JsonApi $serializer
return	NilPortugues\Laravel5\JsonApi\JsonApiSerializer