DigitalObjectViewerHelper
in package
Digital Object Viewer Helper - IIIF and media viewer rendering
Table of Contents
Methods
- getPreferredIiifViewer() : string
- Get user's preferred IIIF viewer
- renderMiradorViewer() : string
- Render Mirador viewer for IIIF content
- renderOpenSeadragonViewer() : string
- Render OpenSeadragon viewer for IIIF content
- renderViewerToggle() : string
- Render viewer toggle buttons for IIIF content
- setPreferredIiifViewer() : void
- Set user's preferred IIIF viewer
Methods
getPreferredIiifViewer()
Get user's preferred IIIF viewer
public
static getPreferredIiifViewer() : string
Return values
stringrenderMiradorViewer()
Render Mirador viewer for IIIF content
public
static renderMiradorViewer(string $iiifIdentifier, int $objId, string $root, mixed $request) : string
Parameters
- $iiifIdentifier : string
- $objId : int
- $root : string
- $request : mixed
Return values
stringrenderOpenSeadragonViewer()
Render OpenSeadragon viewer for IIIF content
public
static renderOpenSeadragonViewer(string $iiifIdentifier, int $objId, string $cantaloupeUrl) : string
Parameters
- $iiifIdentifier : string
- $objId : int
- $cantaloupeUrl : string
Return values
stringrenderViewerToggle()
Render viewer toggle buttons for IIIF content
public
static renderViewerToggle(int $objId[, string $currentViewer = 'openseadragon' ]) : string
Parameters
- $objId : int
- $currentViewer : string = 'openseadragon'
Return values
stringsetPreferredIiifViewer()
Set user's preferred IIIF viewer
public
static setPreferredIiifViewer(string $viewer) : void
Parameters
- $viewer : string