Heratio Framework API Reference

IiifViewerService
in package

Service for managing IIIF Viewer settings and rendering.

Table of Contents

Methods

buildImageUrl()  : string
Build IIIF image URL for Cantaloupe.
buildThumbnailUrl()  : string
Build thumbnail URL.
getAllSettings()  : array<string|int, mixed>
Get all settings as array.
getDigitalObjects()  : array<string|int, mixed>
Get digital objects for an information object.
getManifestUrl()  : string
Get IIIF manifest URL for an object.
getSetting()  : mixed
Get a single setting.
loadSettings()  : array<string|int, mixed>
Load all settings from database.
updateSetting()  : bool
Update a setting.
updateSettings()  : bool
Update multiple settings.

Methods

buildImageUrl()

Build IIIF image URL for Cantaloupe.

public buildImageUrl(object $digitalObject[, string $size = 'full' ]) : string
Parameters
$digitalObject : object
$size : string = 'full'
Return values
string

buildThumbnailUrl()

Build thumbnail URL.

public buildThumbnailUrl(object $digitalObject[, int $width = 200 ]) : string
Parameters
$digitalObject : object
$width : int = 200
Return values
string

getAllSettings()

Get all settings as array.

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

getDigitalObjects()

Get digital objects for an information object.

public getDigitalObjects(int $objectId) : array<string|int, mixed>
Parameters
$objectId : int
Return values
array<string|int, mixed>

getManifestUrl()

Get IIIF manifest URL for an object.

public getManifestUrl(string $slug) : string
Parameters
$slug : string
Return values
string

getSetting()

Get a single setting.

public getSetting(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

loadSettings()

Load all settings from database.

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

updateSetting()

Update a setting.

public updateSetting(string $key, string $value) : bool
Parameters
$key : string
$value : string
Return values
bool

updateSettings()

Update multiple settings.

public updateSettings(array<string|int, mixed> $settings) : bool
Parameters
$settings : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results