SortFacetList
extends AbstractHelper
in package
implements
HasSorterInterface
Uses
HasSorterTrait
Sort facet list view helper
Tags
Interfaces, Classes, Traits and Enums
- HasSorterInterface
- Interface SortingInterface
Table of Contents
- $sorter : SorterInterface|null
- Sorter
- __invoke() : array<string|int, mixed>
- Turns facet information into an alphabetical list.
- getSorter() : SorterInterface
- Get the sorter
- setSorter() : void
- Set the sorter
- facetValueToString() : string
- Convert a facet array to a string.
Properties
$sorter
Sorter
protected
SorterInterface|null
$sorter
= null
Methods
__invoke()
Turns facet information into an alphabetical list.
public
__invoke(Results $results, string $field, array<string|int, mixed> $list, array<string|int, mixed> $searchRoute[, string $formatString = '%%displayText%%' ]) : array<string|int, mixed>
Parameters
- $results : Results
-
Search result object
- $field : string
-
Facet field to sort
- $list : array<string|int, mixed>
-
Facet value list extract from the search result object's getFacetList method
- $searchRoute : array<string|int, mixed>
-
Route to use to generate search URLs for individual facet values
- $formatString : string = '%%displayText%%'
-
String for formatting facet values (e.g. with %%displayText%% and %%count%% tokens)
Return values
array<string|int, mixed> —Associative URL => description array sorted by description
getSorter()
Get the sorter
public
getSorter() : SorterInterface
Return values
SorterInterface —setSorter()
Set the sorter
public
setSorter(SorterInterface $sorter) : void
Parameters
- $sorter : SorterInterface
-
Sorter service
Return values
void —facetValueToString()
Convert a facet array to a string.
protected
facetValueToString(array<string|int, mixed> $values, string $format) : string
Parameters
- $values : array<string|int, mixed>
-
Facet value array
- $format : string
-
Format string