Bookplate
in package
implements
RelatedInterface
Related Records: Bookplates
Tags
Interfaces, Classes, Traits and Enums
- RelatedInterface
- Related Records Interface
Table of Contents
- $bookplateImages : mixed
- Bookplate image names or full URLs
- $bookplateStrs : mixed
- Bookplate strings
- $bookplateThumbnails : mixed
- Bookplate thumbnail image names or thumbnail URLs
- $config : mixed
- Bookplate config
- $configLoader : PluginManager
- Configuration loader
- $displayTitles : mixed
- Display bookplate titles?
- $fields : mixed
- Data fields (usually Solr)
- $fullUrlTemplate : mixed
- URL template for full bookplate
- $thumbUrlTemplate : mixed
- URL template for thumbnail
- __construct() : mixed
- Constructor
- getBookplateDetails() : array<string|int, mixed>
- Get bookplate details for display.
- init() : void
- Establishes base settings for bookplates.
- displayBookplateTitles() : bool
- Display titles under bookplates.
- getBookplateData() : array<string|int, mixed>
- Get an array of data representing bookplates.
- getBookplateFullImagesField() : string
- Get a data field with an array of strings that represent full images.
- getBookplateFullUrlTemplate() : string
- Get the full bookplate URL string template.
- getBookplateThumbnailsField() : string
- Get a data field with an array of strings that represent thumbnails.
- getBookplateThumbUrlTemplate() : string
- Get the bookplate URL thumbnail string template.
- getBookplateTitlesField() : string
- Get a data field with an array of bookplate image titles.
Properties
$bookplateImages
Bookplate image names or full URLs
protected
mixed
$bookplateImages
$bookplateStrs
Bookplate strings
protected
mixed
$bookplateStrs
$bookplateThumbnails
Bookplate thumbnail image names or thumbnail URLs
protected
mixed
$bookplateThumbnails
$config
Bookplate config
protected
mixed
$config
$configLoader
Configuration loader
protected
PluginManager
$configLoader
$displayTitles
Display bookplate titles?
protected
mixed
$displayTitles
$fields
Data fields (usually Solr)
protected
mixed
$fields
$fullUrlTemplate
URL template for full bookplate
protected
mixed
$fullUrlTemplate
$thumbUrlTemplate
URL template for thumbnail
protected
mixed
$thumbUrlTemplate
Methods
__construct()
Constructor
public
__construct(PluginManager $configLoader) : mixed
Parameters
- $configLoader : PluginManager
-
PluginManager
Return values
mixed —getBookplateDetails()
Get bookplate details for display.
public
getBookplateDetails() : array<string|int, mixed>
Return values
array<string|int, mixed> —init()
Establishes base settings for bookplates.
public
init(string $settings, AbstractBase $driver) : void
Parameters
- $settings : string
-
Settings from config.ini
- $driver : AbstractBase
-
Record driver object
Return values
void —displayBookplateTitles()
Display titles under bookplates.
protected
displayBookplateTitles() : bool
Return values
bool —getBookplateData()
Get an array of data representing bookplates.
protected
getBookplateData( $field) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —getBookplateFullImagesField()
Get a data field with an array of strings that represent full images.
protected
getBookplateFullImagesField() : string
These could be the unique parts of image names (e.g. donor code) or full paths to image files.
Return values
string —getBookplateFullUrlTemplate()
Get the full bookplate URL string template.
protected
getBookplateFullUrlTemplate() : string
Return values
string —getBookplateThumbnailsField()
Get a data field with an array of strings that represent thumbnails.
protected
getBookplateThumbnailsField() : string
These could be the unique parts of thumbnail names (e.g. donor code) or full paths to thumbnail image files.
Return values
string —getBookplateThumbUrlTemplate()
Get the bookplate URL thumbnail string template.
protected
getBookplateThumbUrlTemplate() : string
Return values
string —getBookplateTitlesField()
Get a data field with an array of bookplate image titles.
protected
getBookplateTitlesField() : string