PHP Class Marcelgwerder\ApiHandler\Result

Show file Open project: marcelgwerder/laravel-api-handler

Protected Properties

Property Type Description
$parser Marcelgwerder\ApiHandler\Parser Parser instance.

Public Methods

Method Description
__construct ( Parser $parser ) : void Create a new result
getBuilder ( ) : Illuminate\Database\Query\Builder Get the query bulder object
getHeaders ( ) : array Get the headers
getMetaProviders ( ) : array Get an array of meta providers
getMode ( ) : string Get the mode of the parser
getResponse ( ) : Illuminate\Support\Facades\Response Return a laravel response object including the correct status code and headers
getResult ( ) : Illuminate\Database\Query\Builder Return the query builder including the results

Method Details

__construct() public method

Create a new result
public __construct ( Parser $parser ) : void
$parser Parser
return void

getBuilder() public method

Get the query bulder object
public getBuilder ( ) : Illuminate\Database\Query\Builder
return Illuminate\Database\Query\Builder

getHeaders() public method

Get the headers
public getHeaders ( ) : array
return array

getMetaProviders() public method

Get an array of meta providers
public getMetaProviders ( ) : array
return array

getMode() public method

Get the mode of the parser
public getMode ( ) : string
return string

getResponse() public method

Return a laravel response object including the correct status code and headers
public getResponse ( ) : Illuminate\Support\Facades\Response
return Illuminate\Support\Facades\Response

getResult() public method

Return the query builder including the results
public getResult ( ) : Illuminate\Database\Query\Builder
return Illuminate\Database\Query\Builder $result

Property Details

$parser protected property

Parser instance.
protected Marcelgwerder\ApiHandler\Parser $parser
return Marcelgwerder\ApiHandler\Parser