VuFind API Documentation

SearchSortTrait

Trait for working with sorting 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

$defaultSortOptions  : array<string|int, string>
VuFind default sort options
$sortControlSelector  : string
Selector for sort control
assertResultTitles()  : void
Check that first and last record of the results are correct
assertSelectedSort()  : void
Assert the selected sort option.
sortResults()  : void
Change sort order of search results

Properties

$defaultSortOptions

VuFind default sort options

protected array<string|int, string> $defaultSortOptions = ['Relevance', 'Date Descending', 'Date Ascending', 'Call Number', 'Author']

$sortControlSelector

Selector for sort control

protected string $sortControlSelector = '#sort_options_1'

Methods

assertResultTitles()

Check that first and last record of the results are correct

protected assertResultTitles(Element $page, int $count, string $first, string $last) : void
Parameters
$page : Element

Current page

$count : int

Expected total result count

$first : string

Expected first title

$last : string

Expected last title

Return values
void

assertSelectedSort()

Assert the selected sort option.

protected assertSelectedSort(Element $page, string $active) : void
Parameters
$page : Element

Current page

$active : string

Selected sort option

Return values
void

sortResults()

Change sort order of search results

protected sortResults(Element $page, string $value) : void
Parameters
$page : Element

Current page

$value : string

Sort option

Return values
void

Search results