PageParametersGroup extends ParametersGroup
in package
Uses CatalogItemsParametersGroupTrait, PaginableItemsParametersGroupTrait, FilterIndexableParametersGroupTrait

This is the page model parameters group class.

Table of Contents

$filterIndexable  : string
$idList  : string
$levels  : int
$onlyActive  : bool
$page  : int
$pagesGroupId  : int
$pagesGroupIdList  : string
$pagesGroupPId  : string
$pageType  : string
$parentId  : int
$parentIdList  : string
$parentPId  : string
$perPage  : int
$pId  : string
$position  : int
$positionList  : string
$q  : 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
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
setPagesGroupId() Sets the pages group internal identifier parameter for this parameters group.  : void
setPagesGroupIdList() Sets a list of pages groups internal identifiers for this parameters group.  : void
setPagesGroupPId() Sets the pages group public identifier parameter for this parameters group.  : void
setPageType() Sets a page type 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
setPosition() Sets a position parameter for this parameters group.  : void
setPositionList() Sets a list of positions parameter for this parameters group.  : void
setQ() Sets a search query 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()  : PageParametersValidator

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 —

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 —

setPagesGroupId()

Sets the pages group internal identifier parameter for this parameters group.

public setPagesGroupId(int $pagesGroupId) : void
Parameters
$pagesGroupId : int
Return values
void —

setPagesGroupIdList()

Sets a list of pages groups internal identifiers for this parameters group.

public setPagesGroupIdList(string $pagesGroupIdList) : void
Parameters
$pagesGroupIdList : string
Return values
void —

setPagesGroupPId()

Sets the pages group public identifier parameter for this parameters group.

public setPagesGroupPId(string $pagesGroupPId) : void
Parameters
$pagesGroupPId : string
Return values
void —

setPageType()

Sets a page type parameter for this parameters group.

public setPageType(string $pageType) : void
Parameters
$pageType : string
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 —

setPosition()

Sets a position parameter for this parameters group.

public setPosition(int $position) : void
Parameters
$position : int
Return values
void —

setPositionList()

Sets a list of positions parameter for this parameters group.

public setPositionList(string $positionList) : void
Parameters
$positionList : 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 —

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