Filter
in package
Uses ElementTrait

This is the Filter class.

The availables filter of the current navigation items will be stored in that class and will remain immutable (only get methods are available)

Tags
see
Filter::getOptions()
see
Filter::getCustomTags()
see
Filter::getCustomTagGroups()
see
Filter::getPrices()
see
Filter::getBrands()
see
Filter::getCategories()
see
ElementTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getBrands() Returns an array of FilterCategory for brands.  : array<string|int, FilterBasic>
getCategories() Returns an array of FilterCategory for categories.  : array<string|int, FilterCategory>
getCustomTagGroups() Returns an array of FilterCustomTagGroups.  : array<string|int, FilterCustomTagGroups>
getCustomTags() Returns an array of FilterCustomTag.  : array<string|int, FilterCustomTag>
getOptions() Returns an array of FilterOption.  : array<string|int, FilterOption>
getPrices() Returns the prices available to filter items (minimum and maximum).  : FilterPrices|null
jsonSerialize() Allow elements to be serialized.  : array<string|int, mixed>
toArray() Used to allow elements to be serialized.  : array<string|int, mixed>
getFieldItem()  : object|null
getFormattedData()  : mixed
setArrayField() Convert an API array of objects to a PHP array of objects.  : array<string|int, mixed>

Methods

__construct()

Elements constructor.

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

Array that contains all the values to the object to initialize

Return values
mixed —

__toString()

Uses "json_encode" function to return the JSON format of the element.

public __toString() : string

Auto-invoked using echo or concatenations.

Return values
string —

getBrands()

Returns an array of FilterCategory for brands.

public getBrands() : array<string|int, FilterBasic>
Return values
array<string|int, FilterBasic> —

getCategories()

Returns an array of FilterCategory for categories.

public getCategories() : array<string|int, FilterCategory>
Return values
array<string|int, FilterCategory> —

getPrices()

Returns the prices available to filter items (minimum and maximum).

public getPrices() : FilterPrices|null
Return values
FilterPrices|null —

jsonSerialize()

Allow elements to be serialized.

public jsonSerialize() : array<string|int, mixed>

Auto-invoked using "json_encode" function.

Return values
array<string|int, mixed> —

toArray()

Used to allow elements to be serialized.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFieldItem()

protected getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
$item : array<string|int, mixed>
$class : string
Return values
object|null —

getFormattedData()

protected getFormattedData(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

setArrayField()

Convert an API array of objects to a PHP array of objects.

protected setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Array that contains all the values to the objects to initialize

$class : string

The PHP class we want the objects to be

Return values
array<string|int, mixed> —

Search results