ResponseListTrait uses trait:short, trait:short
Table of Contents
Methods
- actionList() : void
- paginationInit() : Paginator|null
- renderList() : void
- requirePagination() : Paginator
- Works like `paginationInit()`, but the paginator is required; a missing component is a wiring error.
- prepareCanonicalUrl() : void
- prepareFilters() : array<int, Filter>
- prepareOrderBy() : array<string, bool>
- preparePerPage() : int
Methods
actionList()
public
actionList() : void
paginationInit()
public
paginationInit(int $perPage) : Paginator|null
Parameters
- $perPage : int
Return values
Paginator|nullrenderList()
public
renderList([int $page = 1 ][, int $count = 20 ]) : void
Parameters
- $page : int = 1
- $count : int = 20
requirePagination()
Works like `paginationInit()`, but the paginator is required; a missing component is a wiring error.
public
requirePagination(int $perPage) : Paginator
Parameters
- $perPage : int
Return values
PaginatorprepareCanonicalUrl()
private
prepareCanonicalUrl([array<string, mixed> $resetParams = [] ]) : void
Parameters
- $resetParams : array<string, mixed> = []
prepareFilters()
private
prepareFilters(int $userId) : array<int, Filter>
Parameters
- $userId : int
Return values
array<int, Filter>prepareOrderBy()
private
prepareOrderBy() : array<string, bool>
Return values
array<string, bool>preparePerPage()
private
preparePerPage(int $count[, int $defaultCount = 20 ]) : int
Parameters
- $count : int
- $defaultCount : int = 20