PHP 클래스 Tobscure\JsonApi\Parameters

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

보호된 프로퍼티들

프로퍼티 타입 설명
$input array

공개 메소드들

메소드 설명
__construct ( array $input )
getFields ( ) : array Get the fields requested for inclusion.
getFilter ( ) : mixed Get a filter item.
getInclude ( array $available = [] ) : array Get the includes.
getLimit ( integer | null $max = null ) : integer | null Get the limit.
getOffset ( integer | null $perPage = null ) : integer Get number of offset.
getSort ( array $available = [] ) : array Get the sort.

보호된 메소드들

메소드 설명
getInput ( string $key, null $default = null ) : mixed Get an input item.
getOffsetFromNumber ( integer $perPage ) : integer Calculate the offset based on the page[number] parameter.
getPage ( string $key ) : string Get the page.

메소드 상세

__construct() 공개 메소드

public __construct ( array $input )
$input array

getFields() 공개 메소드

Get the fields requested for inclusion.
public getFields ( ) : array
리턴 array

getFilter() 공개 메소드

Get a filter item.
public getFilter ( ) : mixed
리턴 mixed

getInclude() 공개 메소드

Get the includes.
public getInclude ( array $available = [] ) : array
$available array
리턴 array

getInput() 보호된 메소드

Get an input item.
protected getInput ( string $key, null $default = null ) : mixed
$key string
$default null
리턴 mixed

getLimit() 공개 메소드

Get the limit.
public getLimit ( integer | null $max = null ) : integer | null
$max integer | null
리턴 integer | null

getOffset() 공개 메소드

Get number of offset.
public getOffset ( integer | null $perPage = null ) : integer
$perPage integer | null
리턴 integer

getOffsetFromNumber() 보호된 메소드

Calculate the offset based on the page[number] parameter.
protected getOffsetFromNumber ( integer $perPage ) : integer
$perPage integer
리턴 integer

getPage() 보호된 메소드

Get the page.
protected getPage ( string $key ) : string
$key string
리턴 string

getSort() 공개 메소드

Get the sort.
public getSort ( array $available = [] ) : array
$available array
리턴 array

프로퍼티 상세

$input 보호되어 있는 프로퍼티

protected array $input
리턴 array