BrandParametersGroup extends ParametersGroup
in package
Uses IdentifiableItemsParametersGroupTrait, PaginableItemsParametersGroupTrait, SortableItemsParametersGroupTrait, FilterIndexableParametersGroupTrait

This is the brand model parameters group class.

Table of Contents

$filterIndexable  : string
$id  : int
$idList  : string
$onlyActive  : bool
$page  : int
$perPage  : int
$pId  : string
$q  : string
$sort  : string
$sortByIdList  : string
$validator  : ParametersValidator
getFilterIndexable() Returns the filter indexable parameter value.  : string
setFilterIndexable() Sets the filter indexable parameter for this parameters group.  : void
setId() Sets the internal identifier 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
setQ() Sets a search query parameter for this parameters group.  : void
setSort() Sets the sort criteria parameter for this parameters group.  : void
setSortByIdList() Sets a list of internal identifiers as a 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()  : BrandParametersValidator

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 —

setQ()

Sets a search query parameter for this parameters group.

public setQ(string $q) : void
Parameters
$q : string
Return values
void —

setSort()

Sets the sort criteria parameter for this parameters group.

public setSort(string $sort) : void
Parameters
$sort : string
Return values
void —

setSortByIdList()

Sets a list of internal identifiers as a sort criteria parameter for this parameters group.

public setSortByIdList(string $sortByIdList) : void
Parameters
$sortByIdList : 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