VuFind API Documentation

VuFindWorkKeys
in package

XSLT importer support methods for work key generation.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Wiki

Table of Contents

getWorkKeys()  : DOMDocument
Get all work identification keys for the record.
deDom()  : string
Force a value to a string, even if it's a DOMElement.
normalize()  : string
Create a key string.

Methods

getWorkKeys()

Get all work identification keys for the record.

public static getWorkKeys(iteratable<string|int, mixed> $uniformTitles, iteratable<string|int, mixed> $titles, iteratable<string|int, mixed> $trimmedTitles, iteratable<string|int, mixed> $authors[, string $includeRegEx = '' ][, string $excludeRegEx = '' ][, string $transliteratorRules = '' ]) : DOMDocument
Parameters
$uniformTitles : iteratable<string|int, mixed>

Uniform title(s) for the work

$titles : iteratable<string|int, mixed>

Other title(s) for the work

$trimmedTitles : iteratable<string|int, mixed>

Title(s) with leading articles, etc., removed

$authors : iteratable<string|int, mixed>

Author(s) for the work

$includeRegEx : string = ''

Regular expression defining characters to keep

$excludeRegEx : string = ''

Regular expression defining characters to remove

$transliteratorRules : string = ''

Optional ICU transliteration rules to be applied before the include and exclude regex's. See https://unicode-org.github.io/icu/userguide/transforms/general/ #icu-transliterators for more information on the transliteration rules.

Return values
DOMDocument

deDom()

Force a value to a string, even if it's a DOMElement.

protected static deDom(string|DOMElement $string) : string
Parameters
$string : string|DOMElement

String to normalize

Return values
string

normalize()

Create a key string.

protected static normalize(string|DOMElement $rawString, string $includeRegEx, string $excludeRegEx, Transliterator $transliterator) : string
Parameters
$rawString : string|DOMElement

String to normalize

$includeRegEx : string

Regular expression defining characters to keep

$excludeRegEx : string

Regular expression defining characters to remove

$transliterator : Transliterator

Transliterator

Return values
string

Search results