SearchTabs
extends AbstractHelper
in package
"Search tabs" view helper
Tags
Table of Contents
- $cachedHiddenFilterParams : array<string|int, mixed>
- Cached hidden filter url params
- $helper : SearchTabsHelper
- Search tab helper
- $request : Request
- Request
- $results : PluginManager
- Search manager
- $url : Url
- Url
- __construct() : mixed
- Constructor
- getCurrentHiddenFilterParams() : string
- Get current hidden filters as a string suitable for search URLs
- getHiddenFilters() : array<string|int, mixed>
- Get an array of hidden filters
- getTabConfig() : array<string|int, mixed>
- Determine information about search tabs
- getTabConfigForParams() : array<string|int, mixed>
- Get the tab configuration
- buildUrlHiddenFilters() : string
- Build a hidden filter query fragment from the given filters
- getAdvancedTabUrl() : string
- Get url for an advanced search tab.
- getHomeTabUrl() : string
- Get an url to "search home".
- remapBasicSearch() : string
- Map a search query from one class to another.
Properties
$cachedHiddenFilterParams
Cached hidden filter url params
protected
array<string|int, mixed>
$cachedHiddenFilterParams
= []
$helper
Search tab helper
protected
SearchTabsHelper
$helper
$request
Request
protected
Request
$request
$results
Search manager
protected
PluginManager
$results
$url
Url
protected
Url
$url
Methods
__construct()
Constructor
public
__construct(PluginManager $results, Url $url, SearchTabsHelper $helper) : mixed
Parameters
- $results : PluginManager
-
Search results plugin manager
- $url : Url
-
URL helper
- $helper : SearchTabsHelper
-
Search tabs helper
Return values
mixed —getCurrentHiddenFilterParams()
Get current hidden filters as a string suitable for search URLs
public
getCurrentHiddenFilterParams(string $searchClassId[, bool $ignoreHiddenFilterMemory = false ][, string $prepend = '&' ]) : string
Parameters
- $searchClassId : string
-
Active search class
- $ignoreHiddenFilterMemory : bool = false
-
Whether to ignore hidden filters in search memory
- $prepend : string = '&'
-
String to prepend to the hidden filters if they're not empty
Return values
string —getHiddenFilters()
Get an array of hidden filters
public
getHiddenFilters(string $searchClassId[, bool $returnDefaultsIfEmpty = true ][, bool $ignoreCurrentRequest = false ]) : array<string|int, mixed>
Parameters
- $searchClassId : string
-
Active search class
- $returnDefaultsIfEmpty : bool = true
-
Whether to return default tab filters if no filters are currently active
- $ignoreCurrentRequest : bool = false
-
Whether to ignore hidden filters in the current request
Return values
array<string|int, mixed> —getTabConfig()
Determine information about search tabs
public
getTabConfig(string $activeSearchClass, string $query, string $handler[, string $type = 'basic' ][, array<string|int, mixed> $hiddenFilters = [] ]) : array<string|int, mixed>
Parameters
- $activeSearchClass : string
-
The search class ID of the active search
- $query : string
-
The current search query
- $handler : string
-
The current search handler
- $type : string = 'basic'
-
The current search type (basic/advanced)
- $hiddenFilters : array<string|int, mixed> = []
-
The current hidden filters
Return values
array<string|int, mixed> —getTabConfigForParams()
Get the tab configuration
public
getTabConfigForParams(Params $params) : array<string|int, mixed>
Parameters
- $params : Params
-
Search parameters
Return values
array<string|int, mixed> —buildUrlHiddenFilters()
Build a hidden filter query fragment from the given filters
protected
buildUrlHiddenFilters(Results $results, array<string|int, mixed> $filters[, string $prepend = '?' ]) : string
Parameters
- $results : Results
-
Search results
- $filters : array<string|int, mixed>
-
Filters
- $prepend : string = '?'
-
String to prepend to the hidden filters if they're not empty
Return values
string —Query parameters
getAdvancedTabUrl()
Get url for an advanced search tab.
protected
getAdvancedTabUrl(string $class, array<string|int, mixed> $filters) : string
Parameters
- $class : string
-
Search class ID
- $filters : array<string|int, mixed>
-
Tab filters
Return values
string —getHomeTabUrl()
Get an url to "search home".
protected
getHomeTabUrl(string $class, array<string|int, mixed> $filters) : string
Parameters
- $class : string
-
Search class ID
- $filters : array<string|int, mixed>
-
Tab filters
Return values
string —remapBasicSearch()
Map a search query from one class to another.
protected
remapBasicSearch(Options $activeOptions, string $targetClass, string $query, string $handler, array<string|int, mixed> $filters) : string
Parameters
- $activeOptions : Options
-
Search options for source
- $targetClass : string
-
Search class ID for target
- $query : string
-
Search query to map
- $handler : string
-
Search handler to map
- $filters : array<string|int, mixed>
-
Tab filters