SearchTabsHelper
extends AbstractHelper
in package
"Search tabs" helper
Tags
Table of Contents
- $filterConfig : array<string|int, mixed>
- Tab filter configuration
- $permissionConfig : array<string|int, mixed>
- Tab permission configuration
- $request : Request
- Request
- $results : PluginManager
- Search manager
- $settings : array<string|int, mixed>
- Tab settings
- $tabConfig : array<string|int, mixed>
- Tab configuration
- __construct() : mixed
- Constructor
- extractClassName() : string
- Extract search class name from a tab id
- filtersMatch() : bool
- Check if given hidden filters match with the hidden filters from configuration
- getHiddenFilters() : array<string|int, mixed>
- Get an array of hidden filters
- getSettings() : array<string|int, mixed>
- Get the tab details
- getTabConfig() : array<string|int, mixed>
- Get the tab configuration
- getTabFilterConfig() : array<string|int, mixed>
- Get the tab filters
- getTabPermissionConfig() : array<string|int, mixed>
- Get the tab permissions
- getDefaultTabHiddenFilters() : null|array<string|int, mixed>
- Get an array of hidden filters for the default tab of the given search class
- parseFilters() : array<string|int, mixed>
- Parse a simple filter array to a keyed array
Properties
$filterConfig
Tab filter configuration
protected
array<string|int, mixed>
$filterConfig
$permissionConfig
Tab permission configuration
protected
array<string|int, mixed>
$permissionConfig
$request
Request
protected
Request
$request
$results
Search manager
protected
PluginManager
$results
$settings
Tab settings
protected
array<string|int, mixed>
$settings
$tabConfig
Tab configuration
protected
array<string|int, mixed>
$tabConfig
Methods
__construct()
Constructor
public
__construct(PluginManager $results, array<string|int, mixed> $tabConfig, array<string|int, mixed> $filterConfig, Request $request[, array<string|int, mixed> $permConfig = [] ][, array<string|int, mixed> $settings = [] ]) : mixed
Parameters
- $results : PluginManager
-
Search results plugin manager
- $tabConfig : array<string|int, mixed>
-
Tab configuration
- $filterConfig : array<string|int, mixed>
-
Tab filter configuration
- $request : Request
-
Request
- $permConfig : array<string|int, mixed> = []
-
Tab permission configuration
- $settings : array<string|int, mixed> = []
-
Tab settings
Return values
mixed —extractClassName()
Extract search class name from a tab id
public
extractClassName(string $tabId) : string
Parameters
- $tabId : string
-
Tab id as defined in config.ini
Return values
string —filtersMatch()
Check if given hidden filters match with the hidden filters from configuration
public
filtersMatch(string $class, array<string|int, mixed> $hiddenFilters, array<string|int, mixed> $configFilters) : bool
Parameters
- $class : string
-
Search class ID
- $hiddenFilters : array<string|int, mixed>
-
Hidden filters
- $configFilters : array<string|int, mixed>
-
Filters from filter configuration
Return values
bool —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> —getSettings()
Get the tab details
public
getSettings() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTabConfig()
Get the tab configuration
public
getTabConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTabFilterConfig()
Get the tab filters
public
getTabFilterConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTabPermissionConfig()
Get the tab permissions
public
getTabPermissionConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDefaultTabHiddenFilters()
Get an array of hidden filters for the default tab of the given search class
protected
getDefaultTabHiddenFilters(string $searchClassId) : null|array<string|int, mixed>
Parameters
- $searchClassId : string
-
Search class
Return values
null|array<string|int, mixed> —parseFilters()
Parse a simple filter array to a keyed array
protected
parseFilters(string $class, array<string|int, mixed> $filters) : array<string|int, mixed>
Parameters
- $class : string
-
Search class ID
- $filters : array<string|int, mixed>
-
Filters to parse