CoverController
extends AbstractActionController
in package
Generates covers for book entries
Tags
Table of Contents
- $config : array<string|int, mixed>
- Configuration settings ([Content] section of config.ini)
- $loader : Loader
- Cover loader
- $proxy : CachingProxy
- Proxy loader
- $sessionSettings : Settings
- Session settings
- __construct() : mixed
- Constructor
- showAction() : Response
- Send image data for display in the view
- unavailableAction() : Response
- Return the default 'image not found' information
- displayImage() : Response
- Support method -- update the view to display the image currently found in the \VuFind\Cover\Loader.
- getImageParams() : array<string|int, mixed>
- Convert image parameters into an array for use by the image loader.
- isValidProxyImageContentType() : bool
- Is the content type allowed by the cover proxy?
- proxyAllowedForUrl() : bool
- Is the provided URL included on the configured allow list?
Properties
$config
Configuration settings ([Content] section of config.ini)
protected
array<string|int, mixed>
$config
$loader
Cover loader
protected
Loader
$loader
$proxy
Proxy loader
protected
CachingProxy
$proxy
$sessionSettings
Session settings
protected
Settings
$sessionSettings
= null
Methods
__construct()
Constructor
public
__construct(Loader $loader, CachingProxy $proxy, Settings $ss[, array<string|int, mixed> $config = [] ]) : mixed
Parameters
- $loader : Loader
-
Cover loader
- $proxy : CachingProxy
-
Proxy loader
- $ss : Settings
-
Session settings
- $config : array<string|int, mixed> = []
-
Configuration settings
Return values
mixed —showAction()
Send image data for display in the view
public
showAction() : Response
Return values
Response —unavailableAction()
Return the default 'image not found' information
public
unavailableAction() : Response
Return values
Response —displayImage()
Support method -- update the view to display the image currently found in the \VuFind\Cover\Loader.
protected
displayImage([string $type = null ][, string $image = null ]) : Response
Parameters
- $type : string = null
-
Content type of image (null to access loader)
- $image : string = null
-
Image data (null to access loader)
Return values
Response —getImageParams()
Convert image parameters into an array for use by the image loader.
protected
getImageParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —isValidProxyImageContentType()
Is the content type allowed by the cover proxy?
protected
isValidProxyImageContentType(string $contentType) : bool
Parameters
- $contentType : string
-
Type to check
Return values
bool —proxyAllowedForUrl()
Is the provided URL included on the configured allow list?
protected
proxyAllowedForUrl(string $url) : bool
Parameters
- $url : string
-
URL to check