VuFind API Documentation

SearchFacetFilterTrait

Trait for working with faceting and filtering of search results.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Main Page

Table of Contents

$activeFilterLabelSelector  : string
CSS selector for finding the active filter labels
$activeFilterSelector  : string
CSS selector for finding the active filter values
$facetExpandedSelector  : string
CSS selector for finding the first expanded hierarchical facet
$facetExpandSelector  : string
CSS selector for finding the first hierarchical facet expand button
$facetSecondLevelActiveLinkSelector  : string
CSS selector for finding the first active second level hierarchical facet
$facetSecondLevelExcludeLinkSelector  : string
CSS selector for finding the first second level hierarchical facet
$facetSecondLevelLinkSelector  : string
CSS selector for finding the first second level hierarchical facet
assertAppliedFilter()  : void
Check that a filter is applied

Properties

$activeFilterLabelSelector

CSS selector for finding the active filter labels

protected string $activeFilterLabelSelector = '.active-filters.hidden-xs .filters .filters-title'

$activeFilterSelector

CSS selector for finding the active filter values

protected string $activeFilterSelector = '.active-filters.hidden-xs .filters .filter-value'

$facetExpandedSelector

CSS selector for finding the first expanded hierarchical facet

protected string $facetExpandedSelector = '.facet-tree button[aria-expanded=true] ~ ul'

$facetExpandSelector

CSS selector for finding the first hierarchical facet expand button

protected string $facetExpandSelector = '.facet-tree .facet-tree__toggle-expanded .facet-tree__expand'

$facetSecondLevelActiveLinkSelector

CSS selector for finding the first active second level hierarchical facet

protected string $facetSecondLevelActiveLinkSelector = '.facet-tree button[aria-expanded=true] ~ ul a.active'

$facetSecondLevelExcludeLinkSelector

CSS selector for finding the first second level hierarchical facet

protected string $facetSecondLevelExcludeLinkSelector = '.facet-tree button[aria-expanded=true] ~ ul a.exclude'

$facetSecondLevelLinkSelector

CSS selector for finding the first second level hierarchical facet

protected string $facetSecondLevelLinkSelector = '.facet-tree button[aria-expanded=true] ~ ul a'

Methods

assertAppliedFilter()

Check that a filter is applied

protected assertAppliedFilter(Element $page, string $expectedFilter) : void
Parameters
$page : Element

Page

$expectedFilter : string

Filter description

Return values
void

Search results