BannerParametersGroup
extends ParametersGroup
in package
Uses
CatalogItemsParametersGroupTrait, PaginableItemsParametersGroupTrait
This is the banner model parameters group class.
Table of Contents
| $idList | : string | |
|---|---|---|
| $limited | : bool | |
| $page | : int | |
| $perPage | : int | |
| $pId | : string | |
| $position | : int | |
| $positionList | : string | |
| $randomItems | : int | |
| $validator | : ParametersValidator | |
| setIdList() | Sets a list of internal identifiers for this parameters group. | : void |
| setLimited() | Sets if the elements will be filtered using this parameters group in function of if they have reached the limit. | : 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 |
| setPosition() | Sets the position parameter for this parameters group. | : void |
| setPositionList() | Sets the positionList parameter for this parameters group. | : void |
| setRandomItems() | Sets the random items 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() | : BannerParametersValidator |
Properties
$idList
protected
string
$idList
$limited
protected
bool
$limited
$page
protected
int
$page
$perPage
protected
int
$perPage
$pId
protected
string
$pId
$position
protected
int
$position
$positionList
protected
string
$positionList
$randomItems
protected
int
$randomItems
$validator
protected
ParametersValidator
$validator
Methods
setIdList()
Sets a list of internal identifiers for this parameters group.
public
setIdList(string $idList) : void
Parameters
- $idList : string
Return values
void —setLimited()
Sets if the elements will be filtered using this parameters group in function of if they have reached the limit.
public
setLimited(bool $limited) : void
Parameters
- $limited : 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 —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 —setRandomItems()
Sets the random items parameter for this parameters group.
public
setRandomItems(int $randomItems) : void
Parameters
- $randomItems : int
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() : BannerParametersValidator