CategoriesTreeParametersGroup
extends ParametersGroup
in package
Uses
PaginableItemsParametersGroupTrait, IdentifiableItemsParametersGroupTrait
This is the area model (categories resources) parameters group class.
Table of Contents
| $id | : int | |
|---|---|---|
| $idList | : string | |
| $levels | : int | |
| $onlyActive | : bool | |
| $page | : int | |
| $perPage | : int | |
| $pId | : string | |
| $q | : string | |
| $sort | : string | |
| $validator | : ParametersValidator | |
| setId() | Sets the internal identifier parameter for this parameters group. | : void |
| setIdList() | Sets a parameter with a list of internal identifiers for this parameters group. | : void |
| setLevels() | Sets the levels parameter for this parameters group. | : void |
| setOnlyActive() | Sets if the elements will be filtered using this parameters group in function of if they are active or not. | : void |
| setPage() | Sets the page parameter for this parameters group. | : void |
| setPerPage() | Sets the per page parameter for this parameters group. | : void |
| setPId() | Sets the public identifier parameter for this parameters group. | : void |
| setQ() | Sets a search query parameter for this parameters group. | : void |
| setSort() | Sets the 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() | : CategoriesTreeParametersValidator |
Properties
$id
protected
int
$id
$idList
protected
string
$idList
$levels
protected
int
$levels
$onlyActive
protected
bool
$onlyActive
$page
protected
int
$page
$perPage
protected
int
$perPage
$pId
protected
string
$pId
$q
protected
string
$q
$sort
protected
string
$sort
$validator
protected
ParametersValidator
$validator
Methods
setId()
Sets the internal identifier parameter for this parameters group.
public
setId(int $id) : void
Parameters
- $id : int
Return values
void —setIdList()
Sets a parameter with a list of internal identifiers for this parameters group.
public
setIdList(string $idList) : void
Parameters
- $idList : string
Return values
void —setLevels()
Sets the levels parameter for this parameters group.
public
setLevels(int $levels) : void
Parameters
- $levels : int
Return values
void —setOnlyActive()
Sets if the elements will be filtered using this parameters group in function of if they are active or not.
public
setOnlyActive(bool $onlyActive) : void
Parameters
- $onlyActive : bool
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 —setPId()
Sets the public identifier parameter for this parameters group.
public
setPId(string $pId) : void
Parameters
- $pId : string
Return values
void —setQ()
Sets a search query parameter for this parameters group.
public
setQ(string $q) : void
Parameters
- $q : string
Return values
void —setSort()
Sets the sort criteria parameter for this parameters group.
public
setSort(string $sort) : void
Parameters
- $sort : 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() : CategoriesTreeParametersValidator