VuFind API Documentation

Options extends Options
in package

Search

Favorites

Uses ExplodeSettingTrait

Search Favorites Options

$advancedHandlers

Advanced search handlers


    protected
        array<string|int, mixed>
    $advancedHandlers
     = []

$alwaysDisplayResetFilters

Should we display a "Reset Filters" link regardless of retainFiltersByDefault?


    protected
        bool
    $alwaysDisplayResetFilters

$autocompleteAutoSubmit

Autocomplete auto submit setting


    protected
        bool
    $autocompleteAutoSubmit
     = true

$autocompleteEnabled

Autocomplete setting


    protected
        bool
    $autocompleteEnabled
     = false

$autocompleteFormattingRules

Autocomplete query formatting rules


    protected
        array<string|int, mixed>
    $autocompleteFormattingRules
     = []

$basicHandlers

Basic search handlers


    protected
        array<string|int, mixed>
    $basicHandlers
     = []

$configLoader

Configuration loader


    protected
        PluginManager
    $configLoader

$defaultFacetDelimiter

Default delimiter used for delimited facets


    protected
        string
    $defaultFacetDelimiter

$defaultFilters

Default filters to apply to new searches


    protected
        array<string|int, mixed>
    $defaultFilters
     = []

$defaultHandler

Default search handler


    protected
        string
    $defaultHandler
     = null

$defaultLimit

Default limit option


    protected
        int
    $defaultLimit
     = 20

$defaultSelectedShards

Default selected shards


    protected
        array<string|int, mixed>
    $defaultSelectedShards
     = []

$defaultSort

Overall default sort option


    protected
        string
    $defaultSort
     = 'relevance'

$defaultSortByHandler

Handler-specific defaults


    protected
        array<string|int, mixed>
    $defaultSortByHandler
     = []

$defaultView

Default view option


    protected
        string
    $defaultView
     = 'list'

$delimitedFacets

Facet settings


    protected
        array<string|int, mixed>
    $delimitedFacets
     = []

$displayCitationLinksInResults

Should we display citation search links in results?


    protected
        bool
    $displayCitationLinksInResults

$facetsIni

Configuration file to read facet settings from


    protected
        string
    $facetsIni
     = 'facets'

$facetSortOptions

Available sort options for facets


    protected
        array<string|int, mixed>
    $facetSortOptions
     = []

$filterHierarchicalFacetsInAdvanced

Should hierarchicalFacetFilters and hierarchicalExcludeFilters apply in advanced search


    protected
        bool
    $filterHierarchicalFacetsInAdvanced
     = false

$firstLastNavigationSupported

Is first/last navigation supported by the backend?


    protected
        bool
    $firstLastNavigationSupported
     = true

$hiddenSortOptions

Allowed hidden sort options


    protected
        array<string|int, mixed>
    $hiddenSortOptions
     = []

$hierarchicalExcludeFilters

Hierarchical exclude filters


    protected
        array<string|int, mixed>
    $hierarchicalExcludeFilters
     = []

$hierarchicalFacetFilters

Hierarchical facet filters


    protected
        array<string|int, mixed>
    $hierarchicalFacetFilters
     = []

$hierarchicalFacets

Hierarchical facets


    protected
        array<string|int, mixed>
    $hierarchicalFacets
     = []

$hierarchicalFacetSeparators

Hierarchical facet separators


    protected
        array<string|int, mixed>
    $hierarchicalFacetSeparators
     = []

$hierarchicalFacetSortSettings

Hierarchical facet sort settings


    protected
        array<string|int, mixed>
    $hierarchicalFacetSortSettings
     = []

$highlight

Highlighting setting


    protected
        bool
    $highlight
     = false

$limitOptions

Available limit options


    protected
        array<string|int, mixed>
    $limitOptions
     = []

$listviewOption

Active list view option (see [List] in searches.ini).


    protected
        string
    $listviewOption
     = 'full'

$loadResultsWithJs

Is loading of results with JavaScript enabled?


    protected
        bool
    $loadResultsWithJs

$mainIni

Configuration file to read global settings from


    protected
        string
    $mainIni
     = 'config'

$processedDelimitedFacets

Convenient field => delimiter lookup array derived from $delimitedFacets.


    protected
        array<string|int, mixed>
    $processedDelimitedFacets
     = null

$recordPageFirstLastNavigation

Is the record page first/last navigation scroller enabled?


    protected
        bool
    $recordPageFirstLastNavigation
     = false

$resultLimit

Maximum number of results (no limit by default)


    protected
        int
    $resultLimit
     = -1

$retainFiltersByDefault

Should we retain filters by default?


    protected
        bool
    $retainFiltersByDefault

$rssSort

RSS-specific sort option


    protected
        string
    $rssSort
     = null

$searchIni

Configuration file to read search settings from


    protected
        string
    $searchIni
     = 'searches'

$shards

Available shards


    protected
        array<string|int, mixed>
    $shards
     = []

$sortOptions

Available sort options


    protected
        array<string|int, mixed>
    $sortOptions
     = []

$specialAdvancedFacets

Special advanced facet settings


    protected
        string
    $specialAdvancedFacets
     = ''

$spellcheck

Spelling setting


    protected
        bool
    $spellcheck
     = true

$topPaginatorStyle

Top pagination control style (none, simple or full)


    protected
        string
    $topPaginatorStyle

$translatedFacets

Facet settings


    protected
        array<string|int, mixed>
    $translatedFacets
     = []

$translatedFacetsFormats

Formats for translated facets


    protected
        array<string|int, mixed>
    $translatedFacetsFormats
     = []

$translatedFacetsTextDomains

Text domains for translated facets


    protected
        array<string|int, mixed>
    $translatedFacetsTextDomains
     = []

$translator

Translator


    protected
        TranslatorInterface
    $translator
     = null

$viewOptions

Available view options


    protected
        array<string|int, mixed>
    $viewOptions
     = []

$visibleShardCheckboxes

Should we present shard checkboxes to the user?


    protected
        bool
    $visibleShardCheckboxes
     = false

__construct()

Constructor


    public
                    __construct(PluginManager $configLoader) : mixed

Parameters

$configLoader : PluginManager: Config loader

Return values

mixed —

autocompleteAutoSubmit()

Should autocomplete auto submit?


    public
                    autocompleteAutoSubmit() : bool

Return values

bool —

autocompleteEnabled()

Is autocomplete enabled?


    public
                    autocompleteEnabled() : bool

Return values

bool —

disableHighlighting()

Turn off highlighting.


    public
                    disableHighlighting() : void

Return values

void —

displayCitationLinksInResults()

Should we display citation search links in results?


    public
                    displayCitationLinksInResults() : bool

Return values

bool —

firstLastNavigationSupported()

Is first/last navigation supported by the backend


    public
                    firstLastNavigationSupported() : bool

Return values

bool —

getAdvancedHandlers()

Basic 'getter' for advanced search handlers.


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

Return values

array<string|int, mixed> —

getAdvancedSearchAction()

Return the route name of the action used for performing advanced searches.


    public
                    getAdvancedSearchAction() : string|bool

Returns false if the feature is not supported.

Return values

string|bool —

getAPISettings()

Load all API-related settings from the relevant ini file(s).


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

Return values

array<string|int, mixed> —

getAutocompleteFormattingRules()

Get autocomplete query formatting rules.


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

Return values

array<string|int, mixed> —

getBasicHandlers()

Basic 'getter' for basic search handlers.


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

Return values

array<string|int, mixed> —

getCitedByAction()

Return the route name for the "cited by" search action. Returns false to cover unimplemented support.


    public
                    getCitedByAction() : string|bool

Return values

string|bool —

getCitesAction()

Return the route name for the "cites" search action. Returns false to cover unimplemented support.


    public
                    getCitesAction() : string|bool

Return values

string|bool —

getDefaultFacetDelimiter()

Returns the defaultFacetDelimiter value.


    public
                    getDefaultFacetDelimiter() : string

Return values

string —

getDefaultFilters()

Get default filters to apply to an empty search.


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

Return values

array<string|int, mixed> —

getDefaultHandler()

Get default search handler.


    public
                    getDefaultHandler() : string

Return values

string —

getDefaultLimit()

Get default limit setting.


    public
                    getDefaultLimit() : int

Return values

int —

getDefaultSelectedShards()

Get an array of default selected shards (values correspond with keys returned by getShards().


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

Return values

array<string|int, mixed> —

getDefaultSortByHandler()

Get the default sort option for the specified search handler.


    public
                    getDefaultSortByHandler([string $handler = null ]) : string

Parameters

$handler : string = null: Search handler being used

Return values

string —

getDefaultView()

Get default view setting.


    public
                    getDefaultView() : int

Return values

int —

getDelimitedFacets()

Get a list of delimited facets


    public
                    getDelimitedFacets([bool $processed = false ]) : array<string|int, mixed>

Parameters

$processed : bool = false: False = return raw values; true = process values into field => delimiter associative array.

Return values

array<string|int, mixed> —

getFacetListAction()

Return the route name for the facet list action. Returns false to cover unimplemented support.


    public
                    getFacetListAction() : string|bool

Return values

string|bool —

getFacetsIni()

Get the name of the ini file used for configuring facet parameters in this object.


    public
                    getFacetsIni() : string

Return values

string —

getFacetSortOptions()

Get an array of sort options for a facet.


    public
                    getFacetSortOptions([string $facet = '*' ]) : array<string|int, mixed>

Parameters

$facet : string = '*': Facet

Return values

array<string|int, mixed> —

getFilterHierarchicalFacetsInAdvanced()

Are hierarchicalFacetFilters and hierarchicalExcludeFilters enabled in advanced search?


    public
                    getFilterHierarchicalFacetsInAdvanced() : bool

Return values

bool —

getFormatForTranslatedFacet()

Look up the format for use when translating a particular facet field.


    public
                    getFormatForTranslatedFacet(string $field) : string

Parameters

$field : string: Field name being translated

Return values

string —

getHandlerForLabel()

Given a label from the configuration file, return the name of the matching handler (basic checked first, then advanced); return the default handler if no match is found.


    public
                    getHandlerForLabel(string $label) : string

Parameters

$label : string: Label to search for

Return values

string —

getHiddenSortOptions()

Get an array of hidden sort options.


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

Return values

array<string|int, mixed> —

getHierarchicalExcludeFilters()

Get hierarchical exclude filters.


    public
                    getHierarchicalExcludeFilters([string|null $field = null ]) : array<string|int, mixed>

Parameters

$field : string|null = null: Field to get or null for all values. Default is null.

Return values

array<string|int, mixed> —

getHierarchicalFacetFilters()

Get hierarchical facet filters.


    public
                    getHierarchicalFacetFilters([string|null $field = null ]) : array<string|int, mixed>

Parameters

$field : string|null = null: Field to get or null for all values. Default is null.

Return values

array<string|int, mixed> —

getHierarchicalFacets()

Get hierarchical facet fields.


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

Return values

array<string|int, mixed> —

getHierarchicalFacetSeparators()

Get hierarchical facet separators.


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

Return values

array<string|int, mixed> —

getHierarchicalFacetSortSettings()

Get hierarchical facet sort settings.


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

Return values

array<string|int, mixed> —

getHumanReadableFieldName()

Translate a field name to a displayable string for rendering a query in human-readable format:


    public
                    getHumanReadableFieldName(string $field) : string

Parameters

$field : string: Field name to display.

Return values

string —

Human-readable version of field name.

getLabelForBasicHandler()

Given a basic handler name, return the corresponding label (or false if none found):


    public
                    getLabelForBasicHandler(string $handler) : string

Parameters

$handler : string: Handler name to look up.

Return values

string —

getLimitOptions()

Get an array of limit options.


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

Return values

array<string|int, mixed> —

getListViewOption()

Get a string of the listviewOption (full or tab).


    public
                    getListViewOption() : string

Return values

string —

getMainIni()

Get the name of the ini file used for loading primary settings in this object.


    public
                    getMainIni() : string

Return values

string —

getRecommendationSettings()

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).


    public
                    getRecommendationSettings([string $handler = null ]) : array<string|int, mixed>

Parameters

$handler : string = null: Name of handler for which to load specific settings.

Return values

array<string|int, mixed> —

associative: location (top/side/etc.) => search settings

getRetainFilterSetting()

Should filter settings be retained across searches by default?


    public
                    getRetainFilterSetting() : bool

Return values

bool —

getRssSort()

Return the sorting value for RSS mode


    public
                    getRssSort(string $sort) : string

Parameters

$sort : string: Sort setting to modify for RSS mode

Return values

string —

getSearchAction()

Return the route name for the search results action.


    public
                    getSearchAction() : string

Return values

string —

getSearchBoxSearchClassId()

Get the search class ID for identifying search box options; this is normally the same as the current search class ID, but some "special purpose" search namespaces (e.g. SolrAuthor) need to point to a different ID for search box generation


    public
                    getSearchBoxSearchClassId() : string

Return values

string —

getSearchClassId()

Get the identifier used for naming the various search classes in this family.


    public
                    getSearchClassId() : string

Return values

string —

getSearchHomeAction()

Return the route name for the search home action.


    public
                    getSearchHomeAction() : string

Return values

string —

getSearchIni()

Get the name of the ini file used for configuring search parameters in this object.


    public
                    getSearchIni() : string

Return values

string —

getShards()

Get an associative array of available shards (key = internal VuFind ID for this shard; value = details needed to connect to shard; empty for non-sharded data sources).


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

Although this mechanism was originally designed for Solr's sharding capabilities, it could also be useful for multi-database search situations (i.e. federated search, EBSCO's API, etc., etc.).

Return values

array<string|int, mixed> —

getSortOptions()

Get an array of sort options.


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

Return values

array<string|int, mixed> —

getSpecialAdvancedFacets()

Get string listing special advanced facet types.


    public
                    getSpecialAdvancedFacets() : string

Return values

string —

getSpellingNormalizer()

Return the callback used for normalization within this backend.


    public
                    getSpellingNormalizer() : callable

Return values

callable —

getTextDomainForTranslatedFacet()

Look up the text domain for use when translating a particular facet field.


    public
                    getTextDomainForTranslatedFacet(string $field) : string

Parameters

$field : string: Field name being translated

Return values

string —

getTopPaginatorStyle()

Get top paginator style


    public
                    getTopPaginatorStyle() : string

Return values

string —

getTranslatedFacets()

Get a list of facets that are subject to translation.


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

Return values

array<string|int, mixed> —

getTranslator()

Get translator object.


    public
                    getTranslator() : TranslatorInterface

Return values

TranslatorInterface —

getTranslatorLocale()

Get the locale from the translator.


    public
                    getTranslatorLocale([string $default = 'en' ]) : string

Parameters

$default : string = 'en': Default to use if translator absent.

Return values

string —

getVersionsAction()

Return the route name for the versions search action. Returns false to cover unimplemented support.


    public
                    getVersionsAction() : string|bool

Return values

string|bool —

getViewOptions()

Get an array of view options.


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

Return values

array<string|int, mixed> —

getVisibleSearchResultLimit()

If there is a limit to how many search results a user can access, this method will return that limit. If there is no limit, this will return -1.


    public
                    getVisibleSearchResultLimit() : int

Return values

int —

highlightEnabled()

Is highlighting enabled?


    public
                    highlightEnabled() : bool

Return values

bool —

limitOrderOverride()

Get advanced search limits that override the natural sorting to display at the top.


    public
                    limitOrderOverride(string $limit) : array<string|int, mixed>

Parameters

$limit : string: advanced search limit

Return values

array<string|int, mixed> —

loadResultsWithJsEnabled()

Should we load results with JavaScript?


    public
                    loadResultsWithJsEnabled() : bool

Return values

bool —

recordFirstLastNavigationEnabled()

Should we include first/last options in record page navigation?


    public
                    recordFirstLastNavigationEnabled() : bool

Return values

bool —

setConfigLoader()

Set the config loader


    public
                    setConfigLoader(PluginManager $configLoader) : void

Parameters

$configLoader : PluginManager: Config loader

Return values

void —

setDefaultFacetDelimiter()

Set the defaultFacetDelimiter value.


    public
                    setDefaultFacetDelimiter(string $defaultFacetDelimiter) : void

Parameters

$defaultFacetDelimiter : string: A default delimiter to be used with delimited facets

Return values

void —

setDelimitedFacets()

Set the delimitedFacets value.


    public
                    setDelimitedFacets(array<string|int, mixed> $delimitedFacets) : void

Parameters

$delimitedFacets : array<string|int, mixed>: An array of delimited facet names

Return values

void —

setLimitOptions()

Override the limit options.


    public
                    setLimitOptions(array<string|int, mixed> $options) : void

Parameters

$options : array<string|int, mixed>: New options to set.

Return values

void —

setTranslatedFacets()

Configure facet translation using an array of field names with optional colon-separated text domains.


    public
                    setTranslatedFacets(array<string|int, mixed> $facets) : void

Parameters

$facets : array<string|int, mixed>: Incoming configuration.

Return values

void —

setTranslator()

Set a translator


    public
                    setTranslator(TranslatorInterface $translator) : TranslatorAwareInterface

Parameters

$translator : TranslatorInterface: Translator

Return values

TranslatorAwareInterface —

shouldDisplayResetFilters()

Should the "Reset Filters" button be displayed?


    public
                    shouldDisplayResetFilters() : bool

Return values

bool —

showShardCheckboxes()

Should we display shard checkboxes for this object?


    public
                    showShardCheckboxes() : bool

Return values

bool —

spellcheckEnabled()

Get current spellcheck setting and (optionally) change it.


    public
                    spellcheckEnabled([bool $bool = null ]) : bool

Parameters

$bool : bool = null: True to enable, false to disable, null to leave alone

Return values

bool —

supportsCart()

Does this search option support the cart/book bag?


    public
                    supportsCart() : bool

Return values

bool —

supportsFirstLastNavigation()

Should we include first/last options in record page navigation?


    public
                    supportsFirstLastNavigation() : bool

Return values

bool —

supportsScheduledSearch()

Does this search backend support scheduled searching?


    public
                    supportsScheduledSearch() : bool

Return values

bool —

translate()

Translate a string (or string-castable object)


    public
                    translate(string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string

Parameters

$target : string|object|array<string|int, mixed>: String to translate or an array of text domain and string to translate
$tokens : array<string|int, mixed> = []: Tokens to inject into the translated string
$default : string = null: Default value to use if no translation is found (null for no default).
$useIcuFormatter : bool = false: Should we use an ICU message formatter instead of the default behavior?
$fallbackDomains : array<string|int, string> = []: Text domains to check if no match is found in the domain specified in $target

Return values

string —

translateWithPrefix()

Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.


    public
                    translateWithPrefix(string $prefix, string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string

Parameters

$prefix : string: Translation key prefix
$target : string|object|array<string|int, mixed>: String to translate or an array of text domain and string to translate
$tokens : array<string|int, mixed> = []: Tokens to inject into the translated string
$default : string = null: Default value to use if no translation is found (null for no default).
$useIcuFormatter : bool = false: Should we use an ICU message formatter instead of the default behavior?
$fallbackDomains : array<string|int, string> = []: Text domains to check if no match is found in the domain specified in $target

Return values

string —

configureAutocomplete()

Configure autocomplete preferences from an .ini file.


    protected
                    configureAutocomplete([Config $searchSettings = null ]) : void

Parameters

$searchSettings : Config = null: Object representation of .ini file

Return values

void —

explodeListSetting()

Explode a comma-delimited setting to an array of trimmed values


    protected
                    explodeListSetting(string $value) : array<string|int, mixed>

Parameters

$value : string: Setting value

Return values

array<string|int, mixed> —

explodeSetting()

Explode a delimited setting to an array


    protected
                    explodeSetting(string $value[, bool $trim = false ][, string $separator = ':' ]) : array<string|int, mixed>

Parameters

$value : string: Setting value
$trim : bool = false: Whether to trim the values (disabled by default to ensure any valid blank entry does not get trimmed, and to avoid doing extra work on each execution)
$separator : string = ':': Separator

Return values

array<string|int, mixed> —

extractTextDomain()

Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.


    protected
                    extractTextDomain(string|object|array<string|int, mixed> $target) : array<string|int, mixed>

Parameters

$target : string|object|array<string|int, mixed>: String to translate or an array of text domain and string to translate

Return values

array<string|int, mixed> —

getDebugTranslation()

Build a debug-mode translation


    protected
                    getDebugTranslation(string $domain, string $str, array<string|int, mixed> $tokens) : string

Parameters

$domain : string: Text domain
$str : string: String to translate
$tokens : array<string|int, mixed>: Tokens to inject into the translated string

Return values

string —

sanitizeTranslationKey()

Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.


    protected
                    sanitizeTranslationKey(string $key) : string

Parameters

$key : string: Key to sanitize

Return values

string —

Sanitized key

translateString()

Get translation for a string


    protected
                    translateString(string $rawStr[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, string $domain = 'default' ][, bool $useIcuFormatter = false ]) : string

Parameters

$rawStr : string: String to translate
$tokens : array<string|int, mixed> = []: Tokens to inject into the translated string
$default : string = null: Default value to use if no translation is found (null for no default).
$domain : string = 'default': Text domain (omit for default)
$useIcuFormatter : bool = false: Should we use an ICU message formatter instead of the default behavior?

Return values

string —

Options extends Options in package Search Favorites Uses ExplodeSettingTrait

Tags

Table of Contents

Properties

$advancedHandlers

$alwaysDisplayResetFilters

$autocompleteAutoSubmit

$autocompleteEnabled

$autocompleteFormattingRules

$basicHandlers

$configLoader

$defaultFacetDelimiter

$defaultFilters

$defaultHandler

$defaultLimit

$defaultSelectedShards

$defaultSort

$defaultSortByHandler

$defaultView

$delimitedFacets

$displayCitationLinksInResults

$facetsIni

$facetSortOptions

$filterHierarchicalFacetsInAdvanced

$firstLastNavigationSupported

$hiddenSortOptions

$hierarchicalExcludeFilters

$hierarchicalFacetFilters

$hierarchicalFacets

$hierarchicalFacetSeparators

$hierarchicalFacetSortSettings

$highlight

$limitOptions

$listviewOption

$loadResultsWithJs

$mainIni

$processedDelimitedFacets

$recordPageFirstLastNavigation

$resultLimit

$retainFiltersByDefault

Options extends Options
in package

Search

Favorites

Uses ExplodeSettingTrait