VuFind API Documentation

RemoveFilters
in package
implements RecommendInterface

RemoveFilters Recommendations Module Recommends to remove filters

This class recommends to remove filters from a query to extend the result.

Tags
category

VuFind

author

Oliver Goldschmidt o.goldschmidt@tuhh.de

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Interfaces, Classes, Traits and Enums

RecommendInterface
Search Recommendations Interface

Table of Contents

$activeFacetsCount  : string
Search handler to try
$results  : Results
Search results object.
getActiveFacetsCount()  : string
Get the new search handler, or false if it does not apply.
getFilterlessUrl()  : string
Get the URL for this query without filters.
hasFilters()  : bool
Determines if filters are applied or not.
init()  : void
Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).
process()  : void
Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.
setConfig()  : void
Store the configuration of the recommendation module.

Properties

$activeFacetsCount

Search handler to try

protected string $activeFacetsCount = 0

Methods

getActiveFacetsCount()

Get the new search handler, or false if it does not apply.

public getActiveFacetsCount() : string
Return values
string —

getFilterlessUrl()

Get the URL for this query without filters.

public getFilterlessUrl() : string
Return values
string —

hasFilters()

Determines if filters are applied or not.

public hasFilters() : bool
Return values
bool —

init()

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

public init(Params $params, Parameters $request) : void

This method is responsible for setting search parameters needed by the recommendation module and for reading any existing search parameters that may be needed.

Parameters
$params : Params

Search parameter object

$request : Parameters

Parameter object representing user request.

Return values
void —

process()

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

public process(Results $results) : void
Parameters
$results : Results

Search results object

Return values
void —

setConfig()

Store the configuration of the recommendation module.

public setConfig(string $settings) : void
Parameters
$settings : string

Settings from searches.ini.

Return values
void —

Search results