VuFind API Documentation

Terms
in package
implements IteratorAggregate

SOLR Terms component.

Tags
category

VuFind

author

David Maus maus@hab.de

license

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

link
https://vufind.org

Interfaces, Classes, Traits and Enums

IteratorAggregate

Table of Contents

$terms  : ArrayObject
Terms, indexed by field.
__construct()  : void
Constructor.
getFieldTerms()  : array<string|int, mixed>
Get terms for the specified field
getIterator()  : Traversable
Return aggregated iterator.
hasFieldTerms()  : bool
Does the requested field exist?

Properties

$terms

Terms, indexed by field.

protected ArrayObject $terms

Methods

__construct()

Constructor.

public __construct(array<string|int, mixed> $terms) : void
Parameters
$terms : array<string|int, mixed>

Term information

Return values
void

getFieldTerms()

Get terms for the specified field

public getFieldTerms(string $field) : array<string|int, mixed>
Parameters
$field : string

Field name

Return values
array<string|int, mixed>

getIterator()

Return aggregated iterator.

public getIterator() : Traversable
Return values
Traversable

hasFieldTerms()

Does the requested field exist?

public hasFieldTerms(string $field) : bool
Parameters
$field : string

Field name

Return values
bool

Search results