VuFind API Documentation

FacetFormatterTest extends TestCase
in package

Unit tests for facet formatter.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link
https://vufind.org

Table of Contents

testFormatter()  : void
Test the facet formatter
testFormatterWithFiltering()  : void
Test the facet formatter with filtering turned on
getFakeFacetData()  : array<string|int, mixed>
Get fake facet data.
getFakeHierarchicalFacetData()  : array<string|int, mixed>
Get fake hierarchical facet data.
getFakeResults()  : Results
Get fake results object.

Methods

testFormatter()

Test the facet formatter

public testFormatter() : void
Return values
void

testFormatterWithFiltering()

Test the facet formatter with filtering turned on

public testFormatterWithFiltering() : void
Return values
void

getFakeFacetData()

Get fake facet data.

protected getFakeFacetData([bool $includeOr = false ]) : array<string|int, mixed>
Parameters
$includeOr : bool = false

Include OR facet data?

Return values
array<string|int, mixed>

getFakeHierarchicalFacetData()

Get fake hierarchical facet data.

protected getFakeHierarchicalFacetData(array<string|int, mixed> $request[, bool $includeOr = false ]) : array<string|int, mixed>
Parameters
$request : array<string|int, mixed>

Request params

$includeOr : bool = false

Include OR facet data?

Return values
array<string|int, mixed>

getFakeResults()

Get fake results object.

protected getFakeResults(array<string|int, mixed> $request, array<string|int, mixed> $facetData) : Results
Parameters
$request : array<string|int, mixed>

Request parameters.

$facetData : array<string|int, mixed>

Facet data to inject into results.

Return values
Results

Search results