PHP 클래스 Flarum\Event\ConfigureApiController

파일 보기 프로젝트 열기: flarum/core 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$controller Flarum\Api\Controller\AbstractSerializeController

공개 메소드들

메소드 설명
__construct ( AbstractSerializeController $controller )
addInclude ( string | array $name ) Include the given relationship by default.
addOptionalInclude ( string $name ) Make the given relationship available for inclusion.
addSortField ( string $field ) Allow sorting results by the given field.
isController ( string $controller ) : boolean
removeInclude ( string $name ) Don't include the given relationship by default.
removeOptionalInclude ( string $name ) Don't allow the given relationship to be included.
removeSortField ( string $field ) Disallow sorting results by the given field.
setLimit ( integer $limit ) Set the default number of results.
setMaxLimit ( integer $max ) Set the maximum number of results.
setSerializer ( string $serializer ) Set the serializer that will serialize data for the endpoint.
setSort ( array $sort ) Set the default sort order for the results.

메소드 상세

__construct() 공개 메소드

public __construct ( AbstractSerializeController $controller )
$controller Flarum\Api\Controller\AbstractSerializeController

addInclude() 공개 메소드

Include the given relationship by default.
public addInclude ( string | array $name )
$name string | array

addOptionalInclude() 공개 메소드

Make the given relationship available for inclusion.
public addOptionalInclude ( string $name )
$name string

addSortField() 공개 메소드

Allow sorting results by the given field.
public addSortField ( string $field )
$field string

isController() 공개 메소드

public isController ( string $controller ) : boolean
$controller string
리턴 boolean

removeInclude() 공개 메소드

Don't include the given relationship by default.
public removeInclude ( string $name )
$name string

removeOptionalInclude() 공개 메소드

Don't allow the given relationship to be included.
public removeOptionalInclude ( string $name )
$name string

removeSortField() 공개 메소드

Disallow sorting results by the given field.
public removeSortField ( string $field )
$field string

setLimit() 공개 메소드

Set the default number of results.
public setLimit ( integer $limit )
$limit integer

setMaxLimit() 공개 메소드

Set the maximum number of results.
public setMaxLimit ( integer $max )
$max integer

setSerializer() 공개 메소드

Set the serializer that will serialize data for the endpoint.
public setSerializer ( string $serializer )
$serializer string

setSort() 공개 메소드

Set the default sort order for the results.
public setSort ( array $sort )
$sort array

프로퍼티 상세

$controller 공개적으로 프로퍼티

public AbstractSerializeController,Flarum\Api\Controller $controller
리턴 Flarum\Api\Controller\AbstractSerializeController