CategoryParametersGroup
extends ParametersGroup
in package
Uses
CatalogItemsParametersGroupTrait, PaginableItemsParametersGroupTrait, FilterIndexableParametersGroupTrait
This is the category model parameters group class.
Table of Contents
| $areaId | : int | |
|---|---|---|
| $areaIdList | : string | |
| $areaPId | : string | |
| $areaPosition | : int | |
| $filterIndexable | : string | |
| $idList | : string | |
| $onlyActive | : bool | |
| $page | : int | |
| $parentId | : int | |
| $parentIdList | : string | |
| $parentPId | : string | |
| $perPage | : int | |
| $pId | : string | |
| $q | : string | |
| $validator | : ParametersValidator | |
| getFilterIndexable() | Returns the filter indexable parameter value. | : string |
| setAreaId() | Sets the area internal identifier parameter for this parameters group. | : void |
| setAreaIdList() | Sets a list of area internal identifiers for this parameters group. | : void |
| setAreaPId() | Sets the area public identifier parameter for this parameters group. | : void |
| setAreaPosition() | Sets the area position parameter for this parameters group. | : void |
| setFilterIndexable() | Sets the filter indexable parameter for this parameters group. | : void |
| setIdList() | Sets a list of internal identifiers 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 |
| setParentId() | Sets the parent internal identifier parameter for this parameters group. | : void |
| setParentIdList() | Sets a list of parent internal identifiers for this parameters group. | : void |
| setParentPId() | Sets the parent public identifier 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 |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : CategoryParametersValidator |
Properties
$areaId
protected
int
$areaId
$areaIdList
protected
string
$areaIdList
$areaPId
protected
string
$areaPId
$areaPosition
protected
int
$areaPosition
$filterIndexable
protected
string
$filterIndexable
$idList
protected
string
$idList
$onlyActive
protected
bool
$onlyActive
$page
protected
int
$page
$parentId
protected
int
$parentId
$parentIdList
protected
string
$parentIdList
$parentPId
protected
string
$parentPId
$perPage
protected
int
$perPage
$pId
protected
string
$pId
$q
protected
string
$q
$validator
protected
ParametersValidator
$validator
Methods
getFilterIndexable()
Returns the filter indexable parameter value.
public
getFilterIndexable() : string
Return values
string —setAreaId()
Sets the area internal identifier parameter for this parameters group.
public
setAreaId(int $areaId) : void
Parameters
- $areaId : int
Return values
void —setAreaIdList()
Sets a list of area internal identifiers for this parameters group.
public
setAreaIdList(string $areaIdList) : void
Parameters
- $areaIdList : string
Return values
void —setAreaPId()
Sets the area public identifier parameter for this parameters group.
public
setAreaPId(string $areaPId) : void
Parameters
- $areaPId : string
Return values
void —setAreaPosition()
Sets the area position parameter for this parameters group.
public
setAreaPosition(int $areaPosition) : void
Parameters
- $areaPosition : int
Return values
void —setFilterIndexable()
Sets the filter indexable parameter for this parameters group.
public
setFilterIndexable(string $filterIndexable) : void
Parameters
- $filterIndexable : string
Return values
void —setIdList()
Sets a list of internal identifiers for this parameters group.
public
setIdList(string $idList) : void
Parameters
- $idList : string
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 —setParentId()
Sets the parent internal identifier parameter for this parameters group.
public
setParentId(int $parentId) : void
Parameters
- $parentId : int
Return values
void —setParentIdList()
Sets a list of parent internal identifiers for this parameters group.
public
setParentIdList(string $parentIdList) : void
Parameters
- $parentIdList : string
Return values
void —setParentPId()
Sets the parent public identifier parameter for this parameters group.
public
setParentPId(string $parentPId) : void
Parameters
- $parentPId : string
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 —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() : CategoryParametersValidator