PHP 인터페이스 Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

파일 보기 프로젝트 열기: neomerx/json-api 0 사용 예제들

공개 메소드들

메소드 설명
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.

메소드 상세

getFieldSet() 공개 메소드

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

getFieldSets() 공개 메소드

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

getFilteringParameters() 공개 메소드

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
리턴 array | null

getIncludePaths() 공개 메소드

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

getPaginationParameters() 공개 메소드

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
리턴 array | null

getSortParameters() 공개 메소드

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

getUnrecognizedParameters() 공개 메소드

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

isEmpty() 공개 메소드

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