PHP Interface Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

Mostrar archivo Open project: neomerx/json-api Interface Usage Examples

Public Methods

Method Description
getFieldSet ( string $type ) : string[] | null Get field names that should be in result.
getFieldSets ( ) : array | null Get field names that should be in result.
getFilteringParameters ( ) : array | null Get filtering parameters.
getIncludePaths ( ) : array | null Get requested include paths.
getPaginationParameters ( ) : array | null Get pagination parameters.
getSortParameters ( ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface[] | null Get sort parameters.
getUnrecognizedParameters ( ) : array | null Get top level parameters that have not been recognized by parser.
isEmpty ( ) : boolean Returns true if inclusion, field set, sorting, paging, and filtering parameters are empty.

Method Details

getFieldSet() public method

Get field names that should be in result.
public getFieldSet ( string $type ) : string[] | null
$type string
return string[] | null

getFieldSets() public method

Get field names that should be in result.
public getFieldSets ( ) : array | null
return array | null

getFilteringParameters() public method

Filtering parameters are not detailed in the specification however a keyword 'filter' is reserved for filtering. This method returns key and value pairs from input 'filter' parameter.
public getFilteringParameters ( ) : array | null
return array | null

getIncludePaths() public method

Get requested include paths.
public getIncludePaths ( ) : array | null
return array | null

getPaginationParameters() public method

Pagination parameters are not detailed in the specification however a keyword 'page' is reserved for pagination. This method returns key and value pairs from input 'page' parameter.
public getPaginationParameters ( ) : array | null
return array | null

getSortParameters() public method

Get sort parameters.
public getSortParameters ( ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface[] | null
return Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface[] | null

getUnrecognizedParameters() public method

Get top level parameters that have not been recognized by parser.
public getUnrecognizedParameters ( ) : array | null
return array | null

isEmpty() public method

Returns true if inclusion, field set, sorting, paging, and filtering parameters are empty.
public isEmpty ( ) : boolean
return boolean