IiifProviderInterface
in
Interface for IIIF manifest providers.
Plugins that provide IIIF functionality should implement this. Register via: AtomFramework\Providers::register('iiif', $implementation)
Table of Contents
Methods
- generateManifest() : array<string|int, mixed>
- Generate a IIIF manifest for an object.
- getViewerUrl() : string|null
- Get viewer URL for an object.
- hasViewer() : bool
- Check if IIIF viewer is available for an object.
Methods
generateManifest()
Generate a IIIF manifest for an object.
public
generateManifest(int $objectId[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $objectId : int
-
The information object ID
- $options : array<string|int, mixed> = []
-
Manifest generation options
Return values
array<string|int, mixed> —IIIF 3.0 compliant manifest
getViewerUrl()
Get viewer URL for an object.
public
getViewerUrl(int $objectId) : string|null
Parameters
- $objectId : int
-
The information object ID
Return values
string|nullhasViewer()
Check if IIIF viewer is available for an object.
public
hasViewer(int $objectId) : bool
Parameters
- $objectId : int
-
The information object ID