PHP Class Marcelgwerder\ApiHandler\ApiHandler

Exibir arquivo Open project: marcelgwerder/laravel-api-handler

Public Methods

Method Description
created ( array | object $object ) : Illuminate\Support\Facades\Response Return a new "created" response object
deleted ( array | object $object = null ) : Illuminate\Support\Facades\Response Return a new "deleted" response object
parseMultiple ( mixed $queryBuilder, array $fullTextSearchColumns = [], array | boolean $queryParams = false ) : Result Return a new Result object for multiple datasets
parseSingle ( mixed $queryBuilder, array | integer $identification, array | boolean $queryParams = false ) : Marcelgwerder\ApiHandler\Result Return a new Result object for a single dataset
updated ( array | object $object = null ) : Illuminate\Support\Facades\Response Return a new "updated" response object

Method Details

created() public method

Return a new "created" response object
public created ( array | object $object ) : Illuminate\Support\Facades\Response
$object array | object
return Illuminate\Support\Facades\Response

deleted() public method

Return a new "deleted" response object
public deleted ( array | object $object = null ) : Illuminate\Support\Facades\Response
$object array | object
return Illuminate\Support\Facades\Response

parseMultiple() public method

Return a new Result object for multiple datasets
public parseMultiple ( mixed $queryBuilder, array $fullTextSearchColumns = [], array | boolean $queryParams = false ) : Result
$queryBuilder mixed Some kind of query builder instance
$fullTextSearchColumns array Columns to search in fulltext search
$queryParams array | boolean A list of query parameter
return Result

parseSingle() public method

Return a new Result object for a single dataset
public parseSingle ( mixed $queryBuilder, array | integer $identification, array | boolean $queryParams = false ) : Marcelgwerder\ApiHandler\Result
$queryBuilder mixed Some kind of query builder instance
$identification array | integer Identification of the dataset to work with
$queryParams array | boolean The parameters used for parsing
return Marcelgwerder\ApiHandler\Result Result object that provides getter methods

updated() public method

Return a new "updated" response object
public updated ( array | object $object = null ) : Illuminate\Support\Facades\Response
$object array | object
return Illuminate\Support\Facades\Response