AreaParametersGroup extends ParametersGroup
in package
Uses CatalogItemsParametersGroupTrait, PaginableItemsParametersGroupTrait, FilterIndexableParametersGroupTrait

This is the area model parameters group class.

Table of Contents

$filterIndexable  : string
$idList  : string
$onlyActive  : bool
$page  : int
$perPage  : int
$pId  : string
$position  : int
$positionList  : string
$randomItems  : int
$validator  : ParametersValidator
getFilterIndexable() Returns the filter indexable parameter value.  : string
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
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()  : AreaParametersValidator

Properties

Methods

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 —

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> —

Search results