VuFind API Documentation

FacetCache extends FacetCache
in package

Search2 FacetCache.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Wiki

Table of Contents

$cacheManager  : Manager
Cache manager
$language  : string
Currently selected language
$results  : Results
Search results object.
__construct()  : mixed
Constructor
getList()  : array<string|int, mixed>
Return facet information. This data may come from the cache.
getResults()  : Results
Get results object used to retrieve facets.
getCacheKey()  : string
Get the cache key for the provided method.
getCacheNamespace()  : string
Get the namespace to use for caching facets.
getFacetResults()  : array<string|int, mixed>
Perform the actual facet lookup.
varDump()  : string
Dump variable into string

Properties

$language

Currently selected language

protected string $language

Methods

__construct()

Constructor

public __construct(Results $r, Manager $cm[, string $language = 'en' ]) : mixed
Parameters
$r : Results

Search results object

$cm : Manager

Cache manager

$language : string = 'en'

Active UI language

Return values
mixed

getList()

Return facet information. This data may come from the cache.

public getList([string $context = 'Advanced' ]) : array<string|int, mixed>
Parameters
$context : string = 'Advanced'

Context of list to retrieve ('Advanced' or 'HomePage')

Return values
array<string|int, mixed>

getCacheKey()

Get the cache key for the provided method.

protected getCacheKey() : string
Return values
string

getCacheNamespace()

Get the namespace to use for caching facets.

protected getCacheNamespace() : string
Return values
string

getFacetResults()

Perform the actual facet lookup.

protected getFacetResults(string $initMethod) : array<string|int, mixed>
Parameters
$initMethod : string

Name of params method to use to request facets

Return values
array<string|int, mixed>

varDump()

Dump variable into string

protected varDump(mixed $var) : string
Parameters
$var : mixed

Variable to export

Return values
string

Search results