RelatedItemsParametersGroup
extends ParametersGroup
in package
This is the related items trait parameters group class.
Table of Contents
| $categoryProducts | : bool | |
|---|---|---|
| $limit | : int | |
| $pId | : string | |
| $position | : int | |
| $positionList | : string | |
| $validator | : ParametersValidator | |
| setCategoryProducts() | Sets if the products will be filtered using this parameters group in function of if they are inside the related categories. | : void |
| setLimit() | Sets the limit parameter for this parameters group. | : void |
| setPId() | Sets the public identifier parameter for this parameters group. | : void |
| setPosition() | Sets the position parameter for this parameters group. | : void |
| setPositionList() | Sets the positionList 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() | : RelatedItemsParametersValidator |
Properties
$categoryProducts
protected
bool
$categoryProducts
$limit
protected
int
$limit
$pId
protected
string
$pId
$position
protected
int
$position
$positionList
protected
string
$positionList
$validator
protected
ParametersValidator
$validator
Methods
setCategoryProducts()
Sets if the products will be filtered using this parameters group in function of if they are inside the related categories.
public
setCategoryProducts(bool $categoryProducts) : void
Use that parameter only calling related items for categories
Parameters
- $categoryProducts : bool
Return values
void —setLimit()
Sets the limit parameter for this parameters group.
public
setLimit(int $limit) : void
Parameters
- $limit : 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 —setPosition()
Sets the position parameter for this parameters group.
public
setPosition(int $position) : void
Parameters
- $position : int
Return values
void —setPositionList()
Sets the positionList parameter for this parameters group.
public
setPositionList(string $positionList) : void
Parameters
- $positionList : 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() : RelatedItemsParametersValidator