OrderParametersGroup
extends ParametersGroup
in package
Uses
PaginableItemsParametersGroupTrait
This is the user model (orders resource) parameters group class.
Table of Contents
| $page | : int | |
|---|---|---|
| $perPage | : int | |
| $sort | : string | |
| $sortByIdList | : string | |
| $validator | : ParametersValidator | |
| setPage() | Sets the page parameter for this parameters group. | : void |
| setPerPage() | Sets the per page parameter for this parameters group. | : void |
| setSort() | Sets the sort criteria parameter for this parameters group. | : void |
| setSortByIdList() | Sets a list of internal identifiers as a sort criteria parameter for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : OrderParametersValidator |
Properties
$page
protected
int
$page
$perPage
protected
int
$perPage
$sort
protected
string
$sort
$sortByIdList
protected
string
$sortByIdList
$validator
protected
ParametersValidator
$validator
Methods
setPage()
Sets the page parameter for this parameters group.
public
setPage(int $page) : void
Parameters
- $page : int
Return values
void —setPerPage()
Sets the per page parameter for this parameters group.
public
setPerPage(int $perPage) : void
Parameters
- $perPage : int
Return values
void —setSort()
Sets the sort criteria parameter for this parameters group.
public
setSort(string $sort) : void
Parameters
- $sort : string
Return values
void —setSortByIdList()
Sets a list of internal identifiers as a sort criteria parameter for this parameters group.
public
setSortByIdList(string $sortByIdList) : void
Parameters
- $sortByIdList : string
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : OrderParametersValidator