ApplicableFilter extends Element
in package
Uses ElementTrait

This is the 'ApplicableFilter' class, a DTO class for the theme configuration data.

The items stored in this class will remain immutable (only get methods are available).
This class extends SDK\Core\Dtos\Element, see this class.

Tags
see
ApplicableFilter::getQMinCharacters()
see
ApplicableFilter::getOrderBy()
see
ApplicableFilter::isEnabled()
see
ApplicableFilter::getItemsToShow()
see
Element
see
ElementTrait

Table of Contents

ENABLED  = 'enabled'
ITEMS_TO_SHOW  = 'itemsToShow'
ORDER_BY  = 'orderBy'
PRIORITY  = 'priority'
Q_MIN_CHARACTERS  = 'qMinCharacters'
SORT  = 'sort'
getItemsToShow() This method returns the applicable items for the filter.  : array<string|int, mixed>
getOrderBy() This method returns the 'order by' to be applied to the filtrable items. It retuns values compatibles with SortableEnum.  : string
getQMinCharacters() This method returns the minimum number of characters to make the list request.  : int
getSort() This method returns the sort to apply to the filtrable item. Retuns values compatibles with ApplicableFilterSortable  : string
isEnabled() This method returns true if the filter is enabled, and false otherwise.  : bool
isPriority() This method the priority to show the filter  : int

Constants

Methods

getItemsToShow()

This method returns the applicable items for the filter.

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

getOrderBy()

This method returns the 'order by' to be applied to the filtrable items. It retuns values compatibles with SortableEnum.

public getOrderBy() : string
Return values
string —

getQMinCharacters()

This method returns the minimum number of characters to make the list request.

public getQMinCharacters() : int
Return values
int —

getSort()

This method returns the sort to apply to the filtrable item. Retuns values compatibles with ApplicableFilterSortable

public getSort() : string
Return values
string —

isEnabled()

This method returns true if the filter is enabled, and false otherwise.

public isEnabled() : bool
Return values
bool —

isPriority()

This method the priority to show the filter

public isPriority() : int
Return values
int —

Search results