Primo
extends DefaultRecord
in package
Model for Primo Central records.
Tags
Table of Contents
- $dbServiceManager : PluginManager
- Database service plugin manager
- $extraDetails : array<string|int, mixed>
- For storing extra data with record
- $fields : array<string|int, mixed>
- Raw data
- $highlight : bool
- Should we highlight fields in search results?
- $labels : array<string|int, mixed>
- Labels for the record
- $mainConfig : Config
- Main VuFind configuration
- $ratingCache : array<string|int, mixed>
- Cache for rating data
- $recordConfig : Config
- Record-specific configuration
- $searchBackendIdentifier : string
- Used for identifying the search backend used to find the record
- $sourceIdentifier : string
- Used for identifying record source backend
- $tableManager : PluginManager
- Database table plugin manager
- $translator : TranslatorInterface
- Translator
- __construct() : mixed
- Constructor
- addLabel() : void
- Add a label for the record
- addOrUpdateRating() : void
- Add or update user's rating for the record.
- addTags() : void
- Add tags to the record.
- deleteTags() : void
- Remove tags from the record.
- exportDisabled() : bool
- Indicate whether export is disabled for a particular format.
- getAccessRestrictions() : array<string|int, mixed>
- Get access restriction notes for the record.
- getAllRecordLinks() : null|array<string|int, mixed>
- Get all record links related to the current record. Each link is returned as array.
- getAllSubjectHeadings() : array<string|int, mixed>
- Get an array of all subject headings associated with the record (may be empty).
- getAuthorDataFields() : array<string|int, mixed>
- Get Author Information with Associated Data Fields
- getAwards() : array<string|int, mixed>
- Get award notes for the record.
- getBibliographyNotes() : array<string|int, mixed>
- Get notes on bibliography content.
- getBreadcrumb() : string
- Get text that can be displayed to represent this record in breadcrumbs.
- getBuildings() : array<string|int, mixed>
- Get the buildings containing the record.
- getCallNumber() : string
- Get the first call number associated with the record (empty string if none).
- getCallNumbers() : array<string|int, mixed>
- Get all call numbers associated with the record.
- getChildRecordCount() : int
- Get the number of child records belonging to this record
- getCitationFormats() : array<string|int, mixed>
- Get an array of supported, user-activated citation formats.
- getCitations() : array<string|int, mixed>
- Get citation references
- getCleanDOI() : mixed
- Return the first valid DOI found in the record (false if none).
- getCleanISBN() : mixed
- Return the first valid ISBN found in the record (favoring ISBN-10 over ISBN-13 when possible).
- getCleanISBNs() : array<string|int, mixed>
- Return all ISBNs found in the record.
- getCleanISMN() : mixed
- Get just the base portion of the first listed ISMN (or false if no ISSMs).
- getCleanISSN() : mixed
- Get just the base portion of the first listed ISSN (or false if no ISSNs).
- getCleanNBN() : mixed
- Get just the first listed national bibliography number (or false if none available).
- getCleanOCLCNum() : mixed
- Get just the first listed OCLC Number (or false if none available).
- getCleanUPC() : mixed
- Get just the first listed UPC Number (or false if none available).
- getCleanUuid() : mixed
- Get just the first listed UUID (Universally unique identifier), or false if none available.
- getCoinsOpenUrl() : string
- Get the OpenURL parameters to represent this record for COinS even if supportsOpenUrl() is false for this RecordDriver.
- getComments() : array<string|int, mixed>
- Get comments associated with this record.
- getContainerEndPage() : string
- Get the end page of the item that contains this record.
- getContainerIssue() : string
- Get the issue of the item that contains this record (i.e. MARC 773l of a journal).
- getContainerRecordID() : string
- Get the container record id.
- getContainerReference() : string
- Get a full, free-form reference to the context of the item that contains this record (i.e. volume, year, issue, pages).
- getContainerStartPage() : string
- Get the start page of the item that contains this record (i.e. MARC 773q of a journal).
- getContainerTitle() : string
- Get the title of the item that contains this record (i.e. MARC 773s of a journal).
- getContainerVolume() : string
- Get the volume of the item that contains this record (i.e. MARC 773v of a journal).
- getContainingCollections() : array<string|int, mixed>
- Get an associative array (id => title) of collections containing this record.
- getContainingLists() : array<string|int, mixed>
- Get a list of lists containing this record.
- getCoordinateLabels() : array<string|int, mixed>
- Get the map display (lat/lon) labels
- getCorporateAuthors() : array<string|int, mixed>
- Get the main corporate authors (if any) for the record.
- getCorporateAuthorsRoles() : array<string|int, mixed>
- Get an array of all main corporate authors roles.
- getCreators() : array<string|int, mixed>
- Get the authors of the record.
- getDateSpan() : array<string|int, mixed>
- Get the date coverage for a record which spans a period of time (i.e. a journal). Use getPublicationDates for publication dates of particular monographic items.
- getDbService() : T
- Get a database service object.
- getDbServiceManager() : PluginManager
- Get the service plugin manager. Throw an exception if it is missing.
- getDbTable() : Gateway
- Get a database table object.
- getDbTableManager() : PluginManager
- Get the table plugin manager. Throw an exception if it is missing.
- getDedupData() : array<string|int, mixed>
- Get information on records deduplicated with this one
- getDeduplicatedAuthors() : array<string|int, mixed>
- Deduplicate author information into associative array with main/corporate/ secondary keys.
- getDescription() : array<string|int, mixed>
- Get the item's description.
- getDisplayCoordinates() : array<string|int, mixed>
- Get the map display (lat/lon) coordinates
- getEdition() : string
- Get the edition of the current record.
- getExtraDetail() : mixed
- Retrieve a piece of supplemental information stored using setExtraDetail().
- getFindingAids() : array<string|int, mixed>
- Get notes on finding aids related to the record.
- getFormats() : array<string|int, mixed>
- Get an array of all the formats associated with the record.
- getGeneralNotes() : array<string|int, mixed>
- Get general notes on the record.
- getGeoLocation() : array<string|int, mixed>
- Get the bbox-geo variable.
- getHierarchicalPlaceNames() : array<string|int, mixed>
- Get hierarchical place names
- getHierarchyTopID() : array<string|int, mixed>
- Get the hierarchy_top_id(s) associated with this item (empty if none).
- getHierarchyTopTitle() : array<string|int, mixed>
- Get the absolute parent title(s) associated with this item (empty if none).
- getHierarchyTrees() : mixed
- Get a list of hierarchy trees containing this record.
- getHierarchyType() : string|bool
- Get the Hierarchy Type (false if none)
- getHighlightedSnippet() : mixed
- Pick one line from the highlighted text (if any) to use as a snippet.
- getHighlightedTitle() : string
- Get a highlighted title string, if available.
- getHumanReadablePublicationDates() : array<string|int, mixed>
- Get human readable publication dates for display purposes (may not be suitable for computer processing -- use getPublicationDates() for that).
- getInstitutions() : array<string|int, mixed>
- Get the institutions holding the record.
- getISBNs() : array<string|int, mixed>
- Get an array of all ISBNs associated with the record (may be empty).
- getIsPartOf() : string
- Get the item's "is part of".
- getISSNs() : array<string|int, mixed>
- Get an array of all ISSNs associated with the record (may be empty).
- getLabels() : array<string|int, mixed>
- Return all labels for the record
- getLanguages() : array<string|int, mixed>
- Get the language associated with the record.
- getLastIndexed() : string
- Get a string representing the last date that the record was indexed.
- getLCCN() : string
- Get a LCCN, normalised according to info:lccn
- getListNotes() : array<string|int, mixed>
- Get notes associated with this record in user lists.
- getNewerTitles() : array<string|int, mixed>
- Get an array of newer titles for the record.
- getOCLC() : array<string|int, mixed>
- Get the OCLC number(s) of the record.
- getOpenUrl() : string
- Get the OpenURL parameters to represent this record (useful for the title attribute of a COinS span tag).
- getPhysicalDescriptions() : array<string|int, mixed>
- Get an array of physical descriptions of the item.
- getPlacesOfPublication() : array<string|int, mixed>
- Get the item's place of publication.
- getPlayingTimes() : array<string|int, mixed>
- Get an array of playing times for the record (if applicable).
- getPreviousTitles() : array<string|int, mixed>
- Get an array of previous titles for the record.
- getPrimaryAuthor() : string
- Get the main author of the record.
- getPrimaryAuthors() : array<string|int, mixed>
- Get the main authors of the record.
- getPrimaryAuthorsRoles() : array<string|int, mixed>
- Get an array of all main authors roles (complementing getSecondaryAuthorsRoles()).
- getPrimaryAuthorsWithHighlighting() : array<string|int, mixed>
- Get primary author information with highlights applied (if applicable)
- getProductionCredits() : array<string|int, mixed>
- Get credits of people involved in production of the item.
- getPublicationDates() : array<string|int, mixed>
- Get the publication dates of the record. See also getDateSpan().
- getPublicationDetails() : array<string|int, mixed>
- Get an array of publication detail lines combining information from getPublicationDates(), getPublishers() and getPlacesOfPublication().
- getPublicationFrequency() : array<string|int, mixed>
- Get an array of publication frequency information.
- getPublishers() : array<string|int, mixed>
- Get the publishers of the record.
- getRatingBreakdown() : array<string|int, mixed>
- Get rating breakdown for this record.
- getRatingData() : array<string|int, mixed>
- Get rating information for this record.
- getRawAuthorHighlights() : array<string|int, mixed>
- Get highlighted author data, if available.
- getRawData() : mixed
- Retrieve raw data from object (primarily for use in staff view and autocomplete; avoid using whenever possible).
- getRealTimeHistory() : array<string|int, mixed>
- Get an array of information about record history, obtained in real-time from the ILS.
- getRealTimeHoldings() : array<string|int, mixed>
- Get an array of information about record holdings, obtained in real-time from the ILS.
- getRelationshipNotes() : array<string|int, mixed>
- Get an array of strings describing relationships to other items.
- getSchemaOrgFormats() : string
- Get schema.org type mapping, expected to be a space-delimited string of sub-types of http://schema.org/CreativeWork, defaulting to CreativeWork itself if nothing else matches.
- getSchemaOrgFormatsArray() : array<string|int, mixed>
- Get schema.org type mapping, an array of sub-types of http://schema.org/CreativeWork, defaulting to CreativeWork itself if nothing else matches.
- getSearchBackendIdentifier() : string
- Return the search backend identifier used to find the record.
- getSecondaryAuthors() : array<string|int, mixed>
- Get an array of all secondary authors (complementing getPrimaryAuthors()).
- getSecondaryAuthorsRoles() : array<string|int, mixed>
- Get an array of all secondary authors roles (complementing getPrimaryAuthorsRoles()).
- getSeries() : array<string|int, mixed>
- Get an array of all series names containing the record. Array entries may be either the name string, or an associative array with 'name' and 'number' keys.
- getShortTitle() : string
- Get the short (pre-subtitle) title of the record.
- getSnippetCaption() : mixed
- Given a field name, return an appropriate caption.
- getSortTitle() : string
- Get a sortable title for the record (i.e. no leading articles).
- getSource() : array<string|int, mixed>
- Get the item's source.
- getSourceIdentifier() : string
- Return the source backend identifier.
- getSubtitle() : string
- Get the subtitle of the record.
- getSummary() : array<string|int, mixed>
- Get an array of summary strings for the record.
- getSystemDetails() : array<string|int, mixed>
- Get an array of technical details on the item represented by the record.
- getTags() : array<string|int, mixed>
- Get tags associated with this record.
- getTargetAudienceNotes() : array<string|int, mixed>
- Get an array of note about the record's target audience.
- getThumbnail() : string|array<string|int, mixed>|bool
- Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.
- getTitle() : string
- Get the full title of the record.
- getTitleSection() : string
- Get the text of the part/section portion of the title.
- getTitleStatement() : string
- Get the statement of responsibility that goes with the title (i.e. "by John Smith").
- getTOC() : array<string|int, mixed>
- Get an array of lines from the table of contents.
- getTranslator() : TranslatorInterface
- Get translator object.
- getTranslatorLocale() : string
- Get the locale from the translator.
- getUniqueID() : string
- Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.
- getUPC() : array<string|int, mixed>
- Get the UPC number(s) of the record.
- getURLs() : array<string|int, mixed>
- Return an array of associative URL arrays with one or more of the following keys:
- getUuids() : array<string|int, mixed>
- Get UUIDs (Universally unique identifier). These are commonly used in, for example, digital library or repository systems and can be a useful match point with third party systems.
- getXML() : mixed
- Return an XML representation of the record using the specified format.
- isCollection() : bool
- Get the value of whether or not this is a collection level record
- isRatingAllowed() : bool
- Check if rating the record is allowed.
- setDbServiceManager() : void
- Set the service plugin manager.
- setDbTableManager() : void
- Set the table plugin manager.
- setExtraDetail() : void
- Store a piece of supplemental information in the record driver.
- setLabels() : void
- Set the labels for the record
- setRawData() : void
- Set raw data to initialize the object.
- setSourceIdentifier() : void
- Set the record source backend identifier.
- setSourceIdentifiers() : void
- Set the source backend identifiers.
- setTranslator() : TranslatorAwareInterface
- Set a translator
- supportsAjaxStatus() : bool
- Returns true if the record supports real-time AJAX status lookups.
- supportsCoinsOpenUrl() : bool
- Checks the current record if it's supported for generating COinS-OpenURLs.
- supportsOpenUrl() : bool
- Checks the current record if it's supported for generating OpenURLs.
- translate() : string
- Translate a string (or string-castable object)
- translateWithPrefix() : string
- Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
- tryMethod() : mixed
- Try to call the requested method and return null if it is unavailable; this is useful for checking for the existence of get methods for particular types of data without causing fatal errors.
- extractTextDomain() : array<string|int, mixed>
- Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
- getArticleOpenUrlParams() : array<string|int, mixed>
- Get OpenURL parameters for an article.
- getBookOpenUrlParams() : array<string|int, mixed>
- Get OpenURL parameters for a book.
- getCoinsID() : string
- Get the COinS identifier.
- getDebugTranslation() : string
- Build a debug-mode translation
- getDefaultOpenUrlParams() : array<string|int, mixed>
- Get default OpenURL parameters.
- getJournalOpenUrlParams() : array<string|int, mixed>
- Get OpenURL parameters for a journal.
- getOpenUrlFormat() : string
- Support method for getOpenUrl() -- pick the OpenURL format.
- getRawLCCN() : string
- Get a raw, unnormalized LCCN. (See getLCCN for normalization).
- getSupportedCitationFormats() : array<string|int, mixed>
- Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see /application/themes/root/helpers/Citation.php, getCitation() method.
- getUnknownFormatOpenUrlParams() : array<string|int, mixed>
- Get OpenURL parameters for an unknown format.
- sanitizeTranslationKey() : string
- Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
- translateString() : string
- Get translation for a string
Properties
$dbServiceManager
Database service plugin manager
protected
PluginManager
$dbServiceManager
$extraDetails
For storing extra data with record
protected
array<string|int, mixed>
$extraDetails
= []
$fields
Raw data
protected
array<string|int, mixed>
$fields
= []
$highlight
Should we highlight fields in search results?
protected
bool
$highlight
= false
$labels
Labels for the record
protected
array<string|int, mixed>
$labels
= []
$mainConfig
Main VuFind configuration
protected
Config
$mainConfig
$ratingCache
Cache for rating data
protected
array<string|int, mixed>
$ratingCache
= []
$recordConfig
Record-specific configuration
protected
Config
$recordConfig
$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
= ''
$tableManager
Database table plugin manager
protected
PluginManager
$tableManager
$translator
Translator
protected
TranslatorInterface
$translator
= null
Methods
__construct()
Constructor
public
__construct([Config $mainConfig = null ][, Config $recordConfig = null ]) : mixed
Parameters
- $mainConfig : Config = null
-
VuFind main configuration (omit for built-in defaults)
- $recordConfig : Config = null
-
Record-specific configuration file (omit to use $mainConfig as $recordConfig)
Return values
mixed —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 —addOrUpdateRating()
Add or update user's rating for the record.
public
addOrUpdateRating(int $userId, int|null $rating) : void
Parameters
- $userId : int
-
ID of the user posting the rating
- $rating : int|null
-
The user-provided rating, or null to clear any existing rating
Tags
Return values
void —addTags()
Add tags to the record.
public
addTags(UserEntityInterface $user, array<string|int, mixed> $tags) : void
Parameters
- $user : UserEntityInterface
-
The user posting the tag
- $tags : array<string|int, mixed>
-
The user-provided tags
Tags
Return values
void —deleteTags()
Remove tags from the record.
public
deleteTags(UserEntityInterface $user, array<string|int, mixed> $tags) : void
Parameters
- $user : UserEntityInterface
-
The user posting the tag
- $tags : array<string|int, mixed>
-
The user-provided tags
Tags
Return values
void —exportDisabled()
Indicate whether export is disabled for a particular format.
public
exportDisabled(string $format) : bool
Parameters
- $format : string
-
Export format
Tags
Return values
bool —getAccessRestrictions()
Get access restriction notes for the record.
public
getAccessRestrictions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAllRecordLinks()
Get all record links related to the current record. Each link is returned as array.
public
getAllRecordLinks() : null|array<string|int, mixed>
NB: to use this method you must override it.
Format:
array(
array(
'title' => label_for_title
'value' => link_name
'link' => link_URI
),
...
)
Return values
null|array<string|int, mixed> —getAllSubjectHeadings()
Get an array of all subject headings associated with the record (may be empty).
public
getAllSubjectHeadings([bool $extended = false ]) : array<string|int, mixed>
Parameters
- $extended : bool = false
-
Whether to return a keyed array with the following keys:
- heading: the actual subject heading chunks
- type: heading type
- source: source vocabulary
Return values
array<string|int, mixed> —getAuthorDataFields()
Get Author Information with Associated Data Fields
public
getAuthorDataFields(string $index[, array<string|int, mixed> $dataFields = [] ]) : array<string|int, mixed>
Parameters
- $index : string
-
The author index [primary, corporate, or secondary] used to construct a method name for retrieving author data (e.g. getPrimaryAuthors).
- $dataFields : array<string|int, mixed> = []
-
An array of fields to used to construct method names for retrieving author-related data (e.g., if you pass 'role' the data method will be similar to getPrimaryAuthorsRoles). This value will also be used as a key associated with each author in the resulting data array.
Return values
array<string|int, mixed> —getAwards()
Get award notes for the record.
public
getAwards() : array<string|int, mixed>
Return values
array<string|int, mixed> —getBibliographyNotes()
Get notes on bibliography content.
public
getBibliographyNotes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getBreadcrumb()
Get text that can be displayed to represent this record in breadcrumbs.
public
abstract getBreadcrumb() : string
Return values
string —Breadcrumb text to represent this record.
getBuildings()
Get the buildings containing the record.
public
getBuildings() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCallNumber()
Get the first call number associated with the record (empty string if none).
public
getCallNumber() : string
Return values
string —getCallNumbers()
Get all call numbers associated with the record.
public
getCallNumbers() : array<string|int, mixed>
Return values
array<string|int, mixed> —getChildRecordCount()
Get the number of child records belonging to this record
public
getChildRecordCount() : int
Return values
int —Number of records
getCitationFormats()
Get an array of supported, user-activated citation formats.
public
getCitationFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —Strings representing citation formats.
getCitations()
Get citation references
public
getCitations() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCleanDOI()
Return the first valid DOI found in the record (false if none).
public
getCleanDOI() : mixed
Return values
mixed —getCleanISBN()
Return the first valid ISBN found in the record (favoring ISBN-10 over ISBN-13 when possible).
public
getCleanISBN() : mixed
Return values
mixed —getCleanISBNs()
Return all ISBNs found in the record.
public
getCleanISBNs([string $mode = 'prefer10' ][, bool $filterInvalid = true ]) : array<string|int, mixed>
Parameters
- $mode : string = 'prefer10'
-
Mode for returning ISBNs:
- 'only10' returns only ISBN-10s
- 'prefer10' returns ISBN-10s if available, otherwise ISBN-13s (default)
- 'normalize13' returns ISBN-13s, normalizing ISBN-10s to ISBN-13s
- $filterInvalid : bool = true
-
Whether to filter out invalid ISBNs
Return values
array<string|int, mixed> —getCleanISMN()
Get just the base portion of the first listed ISMN (or false if no ISSMs).
public
getCleanISMN() : mixed
Return values
mixed —getCleanISSN()
Get just the base portion of the first listed ISSN (or false if no ISSNs).
public
getCleanISSN() : mixed
Return values
mixed —getCleanNBN()
Get just the first listed national bibliography number (or false if none available).
public
getCleanNBN() : mixed
Return values
mixed —getCleanOCLCNum()
Get just the first listed OCLC Number (or false if none available).
public
getCleanOCLCNum() : mixed
Return values
mixed —getCleanUPC()
Get just the first listed UPC Number (or false if none available).
public
getCleanUPC() : mixed
Return values
mixed —getCleanUuid()
Get just the first listed UUID (Universally unique identifier), or false if none available.
public
getCleanUuid() : mixed
Return values
mixed —getCoinsOpenUrl()
Get the OpenURL parameters to represent this record for COinS even if supportsOpenUrl() is false for this RecordDriver.
public
getCoinsOpenUrl() : string
Return values
string —OpenURL parameters.
getComments()
Get comments associated with this record.
public
getComments() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getContainerEndPage()
Get the end page of the item that contains this record.
public
getContainerEndPage() : string
Return values
string —getContainerIssue()
Get the issue of the item that contains this record (i.e. MARC 773l of a journal).
public
getContainerIssue() : string
Return values
string —getContainerRecordID()
Get the container record id.
public
getContainerRecordID() : string
Return values
string —Container record id (empty string if none)
getContainerReference()
Get a full, free-form reference to the context of the item that contains this record (i.e. volume, year, issue, pages).
public
getContainerReference() : string
Return values
string —getContainerStartPage()
Get the start page of the item that contains this record (i.e. MARC 773q of a journal).
public
getContainerStartPage() : string
Return values
string —getContainerTitle()
Get the title of the item that contains this record (i.e. MARC 773s of a journal).
public
getContainerTitle() : string
Return values
string —getContainerVolume()
Get the volume of the item that contains this record (i.e. MARC 773v of a journal).
public
getContainerVolume() : string
Return values
string —getContainingCollections()
Get an associative array (id => title) of collections containing this record.
public
getContainingCollections() : array<string|int, mixed>
Return values
array<string|int, mixed> —getContainingLists()
Get a list of lists containing this record.
public
getContainingLists([int $user_id = null ]) : array<string|int, mixed>
Parameters
- $user_id : int = null
-
ID of user to load tags from (null for all users)
Tags
Return values
array<string|int, mixed> —getCoordinateLabels()
Get the map display (lat/lon) labels
public
getCoordinateLabels() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCorporateAuthors()
Get the main corporate authors (if any) for the record.
public
getCorporateAuthors() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCorporateAuthorsRoles()
Get an array of all main corporate authors roles.
public
getCorporateAuthorsRoles() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCreators()
Get the authors of the record.
public
getCreators() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDateSpan()
Get the date coverage for a record which spans a period of time (i.e. a journal). Use getPublicationDates for publication dates of particular monographic items.
public
getDateSpan() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDbService()
Get a database service object.
public
getDbService(class-string<\VuFind\Db\Service\T> $name) : T
Parameters
- $name : class-string<\VuFind\Db\Service\T>
-
Name of service to retrieve
Tags
Return values
T —getDbServiceManager()
Get the service plugin manager. Throw an exception if it is missing.
public
getDbServiceManager() : PluginManager
Tags
Return values
PluginManager —getDbTable()
Get a database table object.
public
getDbTable(string $table) : Gateway
Parameters
- $table : string
-
Table to load.
Return values
Gateway —getDbTableManager()
Get the table plugin manager. Throw an exception if it is missing.
public
getDbTableManager() : PluginManager
Tags
Return values
PluginManager —getDedupData()
Get information on records deduplicated with this one
public
getDedupData() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array keyed by source id containing record id
getDeduplicatedAuthors()
Deduplicate author information into associative array with main/corporate/ secondary keys.
public
getDeduplicatedAuthors([array<string|int, mixed> $dataFields = ['role'] ]) : array<string|int, mixed>
Parameters
- $dataFields : array<string|int, mixed> = ['role']
-
An array of extra data fields to retrieve (see getAuthorDataFields)
Return values
array<string|int, mixed> —getDescription()
Get the item's description.
public
getDescription() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDisplayCoordinates()
Get the map display (lat/lon) coordinates
public
getDisplayCoordinates() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEdition()
Get the edition of the current record.
public
getEdition() : string
Return values
string —getExtraDetail()
Retrieve a piece of supplemental information stored using setExtraDetail().
public
getExtraDetail(string $key) : mixed
Parameters
- $key : string
-
Name of stored information
Return values
mixed —getFindingAids()
Get notes on finding aids related to the record.
public
getFindingAids() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFormats()
Get an array of all the formats associated with the record.
public
getFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —getGeneralNotes()
Get general notes on the record.
public
getGeneralNotes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getGeoLocation()
Get the bbox-geo variable.
public
getGeoLocation() : array<string|int, mixed>
Return values
array<string|int, mixed> —getHierarchicalPlaceNames()
Get hierarchical place names
public
getHierarchicalPlaceNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getHierarchyTopID()
Get the hierarchy_top_id(s) associated with this item (empty if none).
public
getHierarchyTopID() : array<string|int, mixed>
Return values
array<string|int, mixed> —getHierarchyTopTitle()
Get the absolute parent title(s) associated with this item (empty if none).
public
getHierarchyTopTitle() : array<string|int, mixed>
Return values
array<string|int, mixed> —getHierarchyTrees()
Get a list of hierarchy trees containing this record.
public
getHierarchyTrees([string $hierarchyID = false ]) : mixed
Parameters
- $hierarchyID : string = false
-
The hierarchy to get the tree for
Tags
Return values
mixed —An associative array of hierarchy trees on success (id => title), false if no hierarchies found
getHierarchyType()
Get the Hierarchy Type (false if none)
public
getHierarchyType() : string|bool
Return values
string|bool —getHighlightedSnippet()
Pick one line from the highlighted text (if any) to use as a snippet.
public
getHighlightedSnippet() : mixed
Return values
mixed —False if no snippet found, otherwise associative array with 'snippet' and 'caption' keys.
getHighlightedTitle()
Get a highlighted title string, if available.
public
getHighlightedTitle() : string
Return values
string —getHumanReadablePublicationDates()
Get human readable publication dates for display purposes (may not be suitable for computer processing -- use getPublicationDates() for that).
public
getHumanReadablePublicationDates() : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstitutions()
Get the institutions holding the record.
public
getInstitutions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getISBNs()
Get an array of all ISBNs associated with the record (may be empty).
public
getISBNs() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIsPartOf()
Get the item's "is part of".
public
getIsPartOf() : string
Return values
string —getISSNs()
Get an array of all ISSNs associated with the record (may be empty).
public
getISSNs() : array<string|int, mixed>
Return values
array<string|int, mixed> —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'
getLanguages()
Get the language associated with the record.
public
getLanguages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLastIndexed()
Get a string representing the last date that the record was indexed.
public
getLastIndexed() : string
Return values
string —getLCCN()
Get a LCCN, normalised according to info:lccn
public
getLCCN() : string
Return values
string —getListNotes()
Get notes associated with this record in user lists.
public
getListNotes([int $list_id = null ][, int $user_id = null ]) : array<string|int, mixed>
Parameters
- $list_id : int = null
-
ID of list to load tags from (null for all lists)
- $user_id : int = null
-
ID of user to load tags from (null for all users)
Tags
Return values
array<string|int, mixed> —getNewerTitles()
Get an array of newer titles for the record.
public
getNewerTitles() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOCLC()
Get the OCLC number(s) of the record.
public
getOCLC() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenUrl()
Get the OpenURL parameters to represent this record (useful for the title attribute of a COinS span tag).
public
getOpenUrl([bool $overrideSupportsOpenUrl = false ]) : string
Parameters
- $overrideSupportsOpenUrl : bool = false
-
Flag to override checking supportsOpenUrl() (default is false)
Return values
string —OpenURL parameters.
getPhysicalDescriptions()
Get an array of physical descriptions of the item.
public
getPhysicalDescriptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPlacesOfPublication()
Get the item's place of publication.
public
getPlacesOfPublication() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPlayingTimes()
Get an array of playing times for the record (if applicable).
public
getPlayingTimes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPreviousTitles()
Get an array of previous titles for the record.
public
getPreviousTitles() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPrimaryAuthor()
Get the main author of the record.
public
getPrimaryAuthor() : string
Return values
string —getPrimaryAuthors()
Get the main authors of the record.
public
getPrimaryAuthors() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPrimaryAuthorsRoles()
Get an array of all main authors roles (complementing getSecondaryAuthorsRoles()).
public
getPrimaryAuthorsRoles() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPrimaryAuthorsWithHighlighting()
Get primary author information with highlights applied (if applicable)
public
getPrimaryAuthorsWithHighlighting() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProductionCredits()
Get credits of people involved in production of the item.
public
getProductionCredits() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPublicationDates()
Get the publication dates of the record. See also getDateSpan().
public
getPublicationDates() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPublicationDetails()
Get an array of publication detail lines combining information from getPublicationDates(), getPublishers() and getPlacesOfPublication().
public
getPublicationDetails() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPublicationFrequency()
Get an array of publication frequency information.
public
getPublicationFrequency() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPublishers()
Get the publishers of the record.
public
getPublishers() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRatingBreakdown()
Get rating breakdown for this record.
public
getRatingBreakdown(array<string|int, mixed> $groups) : array<string|int, mixed>
Returns an array with the following keys:
rating - average rating (0-100) count - count of ratings groups - grouped counts
Parameters
- $groups : array<string|int, mixed>
-
Group definition (key => [min, max])
Tags
Return values
array<string|int, mixed> —getRatingData()
Get rating information for this record.
public
getRatingData([int|null $userId = null ]) : array<string|int, mixed>
Returns an array with the following keys:
rating - average rating (0-100) count - count of ratings
Parameters
- $userId : int|null = null
-
User ID, or null for all users
Tags
Return values
array<string|int, mixed> —getRawAuthorHighlights()
Get highlighted author data, if available.
public
getRawAuthorHighlights() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRawData()
Retrieve raw data from object (primarily for use in staff view and autocomplete; avoid using whenever possible).
public
getRawData() : mixed
Return values
mixed —getRealTimeHistory()
Get an array of information about record history, obtained in real-time from the ILS.
public
getRealTimeHistory() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRealTimeHoldings()
Get an array of information about record holdings, obtained in real-time from the ILS.
public
getRealTimeHoldings() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRelationshipNotes()
Get an array of strings describing relationships to other items.
public
getRelationshipNotes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSchemaOrgFormats()
Get schema.org type mapping, expected to be a space-delimited string of sub-types of http://schema.org/CreativeWork, defaulting to CreativeWork itself if nothing else matches.
public
getSchemaOrgFormats() : string
Return values
string —getSchemaOrgFormatsArray()
Get schema.org type mapping, an array of sub-types of http://schema.org/CreativeWork, defaulting to CreativeWork itself if nothing else matches.
public
getSchemaOrgFormatsArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSearchBackendIdentifier()
Return the search backend identifier used to find the record.
public
getSearchBackendIdentifier() : string
Return values
string —getSecondaryAuthors()
Get an array of all secondary authors (complementing getPrimaryAuthors()).
public
getSecondaryAuthors() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSecondaryAuthorsRoles()
Get an array of all secondary authors roles (complementing getPrimaryAuthorsRoles()).
public
getSecondaryAuthorsRoles() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSeries()
Get an array of all series names containing the record. Array entries may be either the name string, or an associative array with 'name' and 'number' keys.
public
getSeries() : array<string|int, mixed>
Return values
array<string|int, mixed> —getShortTitle()
Get the short (pre-subtitle) title of the record.
public
getShortTitle() : string
Return values
string —getSnippetCaption()
Given a field name, return an appropriate caption.
public
getSnippetCaption(string $field) : mixed
Parameters
- $field : string
-
Field name
Tags
Return values
mixed —Caption if found, false if none available.
getSortTitle()
Get a sortable title for the record (i.e. no leading articles).
public
getSortTitle() : string
Return values
string —getSource()
Get the item's source.
public
getSource() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSourceIdentifier()
Return the source backend identifier.
public
getSourceIdentifier() : string
Return values
string —getSubtitle()
Get the subtitle of the record.
public
getSubtitle() : string
Return values
string —getSummary()
Get an array of summary strings for the record.
public
getSummary() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSystemDetails()
Get an array of technical details on the item represented by the record.
public
getSystemDetails() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTags()
Get tags associated with this record.
public
getTags([int $list_id = null ][, int $user_id = null ][, string $sort = 'count' ][, int $ownerId = null ]) : array<string|int, mixed>
Parameters
- $list_id : int = null
-
ID of list to load tags from (null for all lists)
- $user_id : int = null
-
ID of user to load tags from (null for all users)
- $sort : string = 'count'
-
Sort type ('count' or 'tag')
- $ownerId : int = null
-
ID of user to check for ownership
Tags
Return values
array<string|int, mixed> —getTargetAudienceNotes()
Get an array of note about the record's target audience.
public
getTargetAudienceNotes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getThumbnail()
Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.
public
getThumbnail([string $size = 'small' ]) : string|array<string|int, mixed>|bool
Parameters
- $size : string = 'small'
-
Size of thumbnail (small, medium or large -- small is default).
Return values
string|array<string|int, mixed>|bool —getTitle()
Get the full title of the record.
public
getTitle() : string
Return values
string —getTitleSection()
Get the text of the part/section portion of the title.
public
getTitleSection() : string
Return values
string —getTitleStatement()
Get the statement of responsibility that goes with the title (i.e. "by John Smith").
public
getTitleStatement() : string
Return values
string —getTOC()
Get an array of lines from the table of contents.
public
getTOC() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTranslator()
Get translator object.
public
getTranslator() : TranslatorInterface
Return values
TranslatorInterface —getTranslatorLocale()
Get the locale from the translator.
public
getTranslatorLocale([string $default = 'en' ]) : string
Parameters
- $default : string = 'en'
-
Default to use if translator absent.
Return values
string —getUniqueID()
Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.
public
getUniqueID() : string
Return values
string —Unique identifier.
getUPC()
Get the UPC number(s) of the record.
public
getUPC() : array<string|int, mixed>
Return values
array<string|int, mixed> —getURLs()
Return an array of associative URL arrays with one or more of the following keys:
public
getURLs() : array<string|int, mixed>
- desc: URL description text to display (optional)
- url: fully-formed URL (required if 'route' is absent)
- route: VuFind route to build URL with (required if 'url' is absent)
- routeParams: Parameters for route (optional)
- queryString: Query params to append after building route (optional)
Return values
array<string|int, mixed> —getUuids()
Get UUIDs (Universally unique identifier). These are commonly used in, for example, digital library or repository systems and can be a useful match point with third party systems.
public
getUuids() : array<string|int, mixed>
Return values
array<string|int, mixed> —getXML()
Return an XML representation of the record using the specified format.
public
getXML(string $format[, string $baseUrl = null ][, RecordLinker $linker = null ]) : mixed
Return false if the format is unsupported.
Parameters
- $format : string
-
Name of format to use (corresponds with OAI-PMH metadataPrefix parameter).
- $baseUrl : string = null
-
Base URL of host containing VuFind (optional; may be used to inject record URLs into XML when appropriate).
- $linker : RecordLinker = null
-
Record linker helper (optional; may be used to inject record URLs into XML when appropriate).
Return values
mixed —XML, or false if format unsupported.
isCollection()
Get the value of whether or not this is a collection level record
public
isCollection() : bool
NOTE: \VuFind\Hierarchy\TreeDataFormatter\AbstractBase::isCollection() duplicates some of this logic.
Return values
bool —isRatingAllowed()
Check if rating the record is allowed.
public
isRatingAllowed() : bool
Return values
bool —setDbServiceManager()
Set the service plugin manager.
public
setDbServiceManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager
Return values
void —setDbTableManager()
Set the table plugin manager.
public
setDbTableManager(PluginManager $manager) : void
Parameters
- $manager : PluginManager
-
Plugin manager
Return values
void —setExtraDetail()
Store a piece of supplemental information in the record driver.
public
setExtraDetail(string $key, mixed $val) : void
Parameters
- $key : string
-
Name of stored information
- $val : mixed
-
Information to store
Return values
void —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 —setRawData()
Set raw data to initialize the object.
public
setRawData(mixed $data) : void
Parameters
- $data : mixed
-
Raw data representing the record; Record Model objects are normally constructed by Record Driver objects using data passed in from a Search Results object. The exact nature of the data may vary depending on the data source -- the important thing is that the Record Driver + Search Results objects work together correctly.
Return values
void —setSourceIdentifier()
Set the record source backend identifier.
public
setSourceIdentifier(string $identifier) : void
Parameters
- $identifier : string
-
Record source identifier
Tags
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 —setTranslator()
Set a translator
public
setTranslator(TranslatorInterface $translator) : TranslatorAwareInterface
Parameters
- $translator : TranslatorInterface
-
Translator
Return values
TranslatorAwareInterface —supportsAjaxStatus()
Returns true if the record supports real-time AJAX status lookups.
public
supportsAjaxStatus() : bool
Return values
bool —supportsCoinsOpenUrl()
Checks the current record if it's supported for generating COinS-OpenURLs.
public
supportsCoinsOpenUrl() : bool
Return values
bool —supportsOpenUrl()
Checks the current record if it's supported for generating OpenURLs.
public
supportsOpenUrl() : bool
Return values
bool —translate()
Translate a string (or string-castable object)
public
translate(string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —translateWithPrefix()
Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
public
translateWithPrefix(string $prefix, string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $prefix : string
-
Translation key prefix
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —tryMethod()
Try to call the requested method and return null if it is unavailable; this is useful for checking for the existence of get methods for particular types of data without causing fatal errors.
public
tryMethod(string $method[, array<string|int, mixed> $params = [] ][, mixed $default = null ]) : mixed
Parameters
- $method : string
-
Name of method to call.
- $params : array<string|int, mixed> = []
-
Array of parameters to pass to method.
- $default : mixed = null
-
A default value to return if the method is not callable
Return values
mixed —extractTextDomain()
Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
protected
extractTextDomain(string|object|array<string|int, mixed> $target) : array<string|int, mixed>
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
Return values
array<string|int, mixed> —getArticleOpenUrlParams()
Get OpenURL parameters for an article.
protected
getArticleOpenUrlParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getBookOpenUrlParams()
Get OpenURL parameters for a book.
protected
getBookOpenUrlParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCoinsID()
Get the COinS identifier.
protected
getCoinsID() : string
Return values
string —getDebugTranslation()
Build a debug-mode translation
protected
getDebugTranslation(string $domain, string $str, array<string|int, mixed> $tokens) : string
Parameters
- $domain : string
-
Text domain
- $str : string
-
String to translate
- $tokens : array<string|int, mixed>
-
Tokens to inject into the translated string
Return values
string —getDefaultOpenUrlParams()
Get default OpenURL parameters.
protected
getDefaultOpenUrlParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getJournalOpenUrlParams()
Get OpenURL parameters for a journal.
protected
getJournalOpenUrlParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenUrlFormat()
Support method for getOpenUrl() -- pick the OpenURL format.
protected
getOpenUrlFormat() : string
Return values
string —getRawLCCN()
Get a raw, unnormalized LCCN. (See getLCCN for normalization).
protected
getRawLCCN() : string
Return values
string —getSupportedCitationFormats()
Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see /application/themes/root/helpers/Citation.php, getCitation() method.
protected
getSupportedCitationFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —Strings representing citation formats.
getUnknownFormatOpenUrlParams()
Get OpenURL parameters for an unknown format.
protected
getUnknownFormatOpenUrlParams([string $format = 'UnknownFormat' ]) : array<string|int, mixed>
Parameters
- $format : string = 'UnknownFormat'
-
Name of format
Return values
array<string|int, mixed> —sanitizeTranslationKey()
Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
protected
sanitizeTranslationKey(string $key) : string
Parameters
- $key : string
-
Key to sanitize
Return values
string —Sanitized key
translateString()
Get translation for a string
protected
translateString(string $rawStr[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, string $domain = 'default' ][, bool $useIcuFormatter = false ]) : string
Parameters
- $rawStr : string
-
String to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $domain : string = 'default'
-
Text domain (omit for default)
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?