SalesAgentCustomersParametersGroup
extends ParametersGroup
in package
Uses
PaginableItemsParametersGroupTrait, FromToDateParametersGroupTrait
This is the user model (sales agent customers resource) parameters group class.
Table of Contents
| $fromDate | : string | |
|---|---|---|
| $page | : int | |
| $perPage | : int | |
| $q | : string | |
| $toDate | : string | |
| $validator | : ParametersValidator | |
| setFromDate() | Sets a start date for this parameters group. | : void |
| setPage() | Sets the page parameter for this parameters group. | : void |
| setPerPage() | Sets the per page parameter for this parameters group. | : void |
| setQ() | Sets a search query parameter for this parameters group. | : void |
| setToDate() | Sets a end date 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() | : SalesAgentCustomersParametersValidator |
Properties
$fromDate
protected
string
$fromDate
$page
protected
int
$page
$perPage
protected
int
$perPage
$q
protected
string
$q
$toDate
protected
string
$toDate
$validator
protected
ParametersValidator
$validator
Methods
setFromDate()
Sets a start date for this parameters group.
public
setFromDate(DateTime $fromDate) : void
Parameters
- $fromDate : DateTime
Return values
void —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 —setQ()
Sets a search query parameter for this parameters group.
public
setQ(string $q) : void
Parameters
- $q : string
Return values
void —setToDate()
Sets a end date for this parameters group.
public
setToDate(DateTime $toDate) : void
Parameters
- $toDate : DateTime
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() : SalesAgentCustomersParametersValidator