PaginationTrait
trait PaginationTrait
Tags
Table of Contents
Properties
- $pageDefaultArgs : array<string|int, mixed>
- $paging : array<string|int, mixed>
Methods
- getPaging() : array<string|int, mixed>
- limit() : void
- offset() : void
- page() : void
- setPaging() : void
- take() : void
Properties
$pageDefaultArgs
protected
static array<string|int, mixed>
$pageDefaultArgs
= ['page' => ['size' => ['type' => 'value', 'valid' => ['Integer'], 'doc' => 'set page size dataCycle API request', 'fn' => [__CLASS__, 'take(int $pageSize)'], 'default' => []], 'number' => ['type' => 'value', 'valid' => ['Integer'], 'doc' => 'set page number dataCycle API request', 'fn' => [__CLASS__, 'page(int $pageNumber)'], 'default' => []]]]
$paging
protected
array<string|int, mixed>
$paging
= ['number' => 1, 'size' => 25]
Methods
getPaging()
public
getPaging() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>limit()
public
limit(int $limit) : void
APIYes
Parameters
- $limit : int
offset()
public
offset(int $offset) : void
APIYes
Parameters
- $offset : int
page()
public
page(int $pageNumber) : void
APIYes
Parameters
- $pageNumber : int
setPaging()
public
setPaging(array<string|int, mixed> $page) : void
APIYes
Parameters
- $page : array<string|int, mixed>
take()
public
take(int $pageSize) : void
APIYes
Parameters
- $pageSize : int