VuFind API Documentation

Record
in package
implements RecordInterface Uses RecordTrait

Simple WorldCat record.

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

RecordInterface
Record interface.

Table of Contents

$labels  : array<string|int, mixed>
Labels for the record
$marc  : MarcReader
MARC record.
$searchBackendIdentifier  : string
Used for identifying the search backend used to find the record
$sourceIdentifier  : string
Used for identifying record source backend
__construct()  : void
Constructor.
addLabel()  : void
Add a label for the record
getLabels()  : array<string|int, mixed>
Return all labels for the record
getMarc()  : MarcReader
Get MARC record
getSearchBackendIdentifier()  : string
Return the search backend identifier used to find the record.
getSourceIdentifier()  : string
Return the source backend identifier.
setLabels()  : void
Set the labels for the record
setSourceIdentifier()  : void
Set the record source backend identifier.
setSourceIdentifiers()  : void
Set the source backend identifiers.

Properties

$labels

Labels for the record

protected array<string|int, mixed> $labels = []

$marc

MARC record.

protected MarcReader $marc

$searchBackendIdentifier

Used for identifying the search backend used to find the record

protected string $searchBackendIdentifier = ''

$sourceIdentifier

Used for identifying record source backend

protected string $sourceIdentifier = ''

Methods

__construct()

Constructor.

public __construct(MarcReader $marc) : void
Parameters
$marc : MarcReader

MARC record

Return values
void

addLabel()

Add a label for the record

public addLabel(string $label, string $class) : void
Parameters
$label : string

Label, may be a translation key

$class : string

Label class

Return values
void

getLabels()

Return all labels for the record

public getLabels() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of associative arrays with keys 'label' and 'class'

getMarc()

Get MARC record

public getMarc() : MarcReader
Return values
MarcReader

getSearchBackendIdentifier()

Return the search backend identifier used to find the record.

public getSearchBackendIdentifier() : string
Return values
string

getSourceIdentifier()

Return the source backend identifier.

public getSourceIdentifier() : string
Return values
string

setLabels()

Set the labels for the record

public setLabels(array<string|int, mixed> $labels) : void
Parameters
$labels : array<string|int, mixed>

An array of associative arrays with keys 'label' and 'class'

Return values
void

setSourceIdentifier()

Set the record source backend identifier.

public setSourceIdentifier(string $identifier) : void
Parameters
$identifier : string

Record source identifier

Tags
deprecated

Use setSourceIdentifiers instead

Return values
void

setSourceIdentifiers()

Set the source backend identifiers.

public setSourceIdentifiers(string $recordSourceId[, string $searchBackendId = '' ]) : void
Parameters
$recordSourceId : string

Record source identifier

$searchBackendId : string = ''

Search backend identifier (if different from $recordSourceId)

Return values
void

Search results