Skip to content
Snippets Groups Projects
Commit b865200c authored by Demian Katz's avatar Demian Katz
Browse files

Adjusted cover loader to use dependency injection for logger; added some missing property comments.

parent 8e920494
No related merge requests found
...@@ -54,6 +54,7 @@ class CoverController extends AbstractBase ...@@ -54,6 +54,7 @@ class CoverController extends AbstractBase
ConfigReader::getConfig(), ConfigReader::getConfig(),
$this->getServiceLocator()->get('CacheManager')->getCacheDir() $this->getServiceLocator()->get('CacheManager')->getCacheDir()
); );
$this->loader->setLogger(\VuFind\Log\Logger::getInstance());
} }
return $this->loader; return $this->loader;
} }
......
...@@ -28,8 +28,7 @@ ...@@ -28,8 +28,7 @@
*/ */
namespace VuFind\Cover; namespace VuFind\Cover;
use VuFind\Code\ISBN, VuFind\Http\Client as HttpClient, use VuFind\Code\ISBN, VuFind\Http\Client as HttpClient,
VuFind\Log\Logger, VuFind\Theme\Tools as ThemeTools, VuFind\Theme\Tools as ThemeTools, Zend\Log\Logger, ZendService\Amazon\Amazon;
ZendService\Amazon\Amazon;
/** /**
* Book Cover Generator * Book Cover Generator
...@@ -43,27 +42,76 @@ use VuFind\Code\ISBN, VuFind\Http\Client as HttpClient, ...@@ -43,27 +42,76 @@ use VuFind\Code\ISBN, VuFind\Http\Client as HttpClient,
*/ */
class Loader class Loader
{ {
// property to hold filename constructed from ISBN /**
* filename constructed from ISBN
*
* @var string
*/
protected $localFile = ''; protected $localFile = '';
// property to hold root directory of VuFind /**
* valid image sizes to request
*
* @var array
*/
protected $validSizes = array('small', 'medium', 'large'); protected $validSizes = array('small', 'medium', 'large');
// property to hold VuFind configuration settings /**
* property to hold VuFind configuration settings
*
* @var \Zend\Config\Config
*/
protected $config; protected $config;
// directory to store downloaded images /**
* directory to store downloaded images
*
* @var string
*/
protected $baseDir; protected $baseDir;
// current user parameters: /**
* User ISN parameter
*
* @var string
*/
protected $isn; protected $isn;
/**
* User size parameter
*
* @var string
*/
protected $size; protected $size;
/**
* User type parameter
*
* @var string
*/
protected $type; protected $type;
// properties populated by calling loadImage or loadUnavailable: /**
* Property for storing raw image data; may be null if image is unavailable
*
* @var string
*/
protected $image = null; protected $image = null;
/**
* Content type of data in $image property
*
* @var string
*/
protected $contentType = null; protected $contentType = null;
/**
* Logger (or false for none)
*
* @var Logger|bool
*/
protected $logger = false;
/** /**
* Constructor * Constructor
* *
...@@ -79,6 +127,32 @@ class Loader ...@@ -79,6 +127,32 @@ class Loader
); );
} }
/**
* Set the logger
*
* @param Logger $logger Logger to use.
*
* @return void
*/
public function setLogger(Logger $logger)
{
$this->logger = $logger;
}
/**
* Log a debug message.
*
* @param string $msg Message to log.
*
* @return void
*/
protected function debug($msg)
{
if ($this->logger) {
$this->logger->debug($msg);
}
}
/** /**
* Get the image data (usually called after loadImage) * Get the image data (usually called after loadImage)
* *
...@@ -278,7 +352,7 @@ class Loader ...@@ -278,7 +352,7 @@ class Loader
// If file defined but does not exist, log error and display default: // If file defined but does not exist, log error and display default:
if (!file_exists($noCoverImage) || !is_readable($noCoverImage)) { if (!file_exists($noCoverImage) || !is_readable($noCoverImage)) {
Logger::getInstance()->debug("Cannot access file: '$noCoverImage'"); $this->debug("Cannot access file: '$noCoverImage'");
return $this->loadDefaultFailImage(); return $this->loadDefaultFailImage();
} }
...@@ -295,7 +369,7 @@ class Loader ...@@ -295,7 +369,7 @@ class Loader
$parts = explode('.', $noCoverImage); $parts = explode('.', $noCoverImage);
$fileExtension = strtolower(end($parts)); $fileExtension = strtolower(end($parts));
if (!array_key_exists($fileExtension, $allowedFileExtensions)) { if (!array_key_exists($fileExtension, $allowedFileExtensions)) {
Logger::getInstance()->debug( $this->debug(
"Illegal file-extension '$fileExtension' for image '$noCoverImage'" "Illegal file-extension '$fileExtension' for image '$noCoverImage'"
); );
return $this->loadDefaultFailImage(); return $this->loadDefaultFailImage();
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment