AreaCategoryParametersGroup extends ParametersGroup
in package
Uses PaginableItemsParametersGroupTrait

This is the area model (categories resources) parameters group class.

Table of Contents

$onlyActive  : bool
$page  : int
$perPage  : int
$sort  : string
$validator  : ParametersValidator
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
setSort() Sets the sort criteria 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()  : AreaCategoryParametersValidator

Properties

Methods

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 —

setSort()

Sets the sort criteria parameter for this parameters group.

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

Search results