Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
16.67% |
1 / 6 |
CRAP | |
26.32% |
5 / 19 |
ImageToolkitBase | |
0.00% |
0 / 1 |
|
28.57% |
2 / 7 |
50.01 | |
26.32% |
5 / 19 |
__construct | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 5 |
|||
validateConfigurationForm | |
100.00% |
1 / 1 |
1 | |
100.00% |
0 / 0 |
|||
setSource | |
0.00% |
0 / 1 |
2.06 | |
75.00% |
3 / 4 |
|||
getSource | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
getRequirements | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
getToolkitOperation | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
apply | |
0.00% |
0 / 1 |
8.67 | |
14.29% |
1 / 7 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\Core\ImageToolkit\ImageToolkitBase. | |
*/ | |
namespace Drupal\Core\ImageToolkit; | |
use Drupal\Component\Plugin\Exception\PluginNotFoundException; | |
use Drupal\Core\Config\ConfigFactoryInterface; | |
use Drupal\Core\Form\FormStateInterface; | |
use Drupal\Core\Plugin\PluginBase; | |
use Psr\Log\LoggerInterface; | |
/** | |
* Provides a base class for image toolkit plugins. | |
* | |
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkit | |
* @see \Drupal\Core\ImageToolkit\ImageToolkitInterface | |
* @see \Drupal\Core\ImageToolkit\ImageToolkitManager | |
* @see plugin_api | |
*/ | |
abstract class ImageToolkitBase extends PluginBase implements ImageToolkitInterface { | |
/** | |
* The config factory. | |
* | |
* @var \Drupal\Core\Config\ConfigFactoryInterface | |
*/ | |
protected $configFactory; | |
/** | |
* Path of the image file. | |
* | |
* @var string | |
*/ | |
protected $source = ''; | |
/** | |
* The image toolkit operation manager. | |
* | |
* @var \Drupal\Core\ImageToolkit\ImageToolkitOperationManagerInterface | |
*/ | |
protected $operationManager; | |
/** | |
* A logger instance. | |
* | |
* @var \Psr\Log\LoggerInterface | |
*/ | |
protected $logger; | |
/** | |
* Constructs an ImageToolkitBase object. | |
* | |
* @param array $configuration | |
* A configuration array containing information about the plugin instance. | |
* @param string $plugin_id | |
* The plugin_id for the plugin instance. | |
* @param array $plugin_definition | |
* The plugin implementation definition. | |
* @param \Drupal\Core\ImageToolkit\ImageToolkitOperationManagerInterface $operation_manager | |
* The toolkit operation manager. | |
* @param \Psr\Log\LoggerInterface $logger | |
* A logger instance. | |
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory | |
* The config factory. | |
*/ | |
public function __construct(array $configuration, $plugin_id, array $plugin_definition, ImageToolkitOperationManagerInterface $operation_manager, LoggerInterface $logger, ConfigFactoryInterface $config_factory) { | |
parent::__construct($configuration, $plugin_id, $plugin_definition); | |
$this->operationManager = $operation_manager; | |
$this->logger = $logger; | |
$this->configFactory = $config_factory; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) { } | |
/** | |
* {@inheritdoc} | |
*/ | |
public function setSource($source) { | |
// If a previous image has been loaded, there is no way to know if the | |
// toolkit implementation needs to perform any additional actions like | |
// freeing memory. Therefore, the source image cannot be changed once set. | |
if ($this->source) { | |
throw new \BadMethodCallException(__METHOD__ . '() may only be called once'); | |
} | |
$this->source = $source; | |
return $this; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function getSource() { | |
return $this->source; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function getRequirements() { | |
return array(); | |
} | |
/** | |
* Gets a toolkit operation plugin instance. | |
* | |
* @param string $operation | |
* The toolkit operation requested. | |
* | |
* @return \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface | |
* An instance of the requested toolkit operation plugin. | |
*/ | |
protected function getToolkitOperation($operation) { | |
return $this->operationManager->getToolkitOperation($this, $operation); | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function apply($operation, array $arguments = array()) { | |
try { | |
// Get the plugin to use for the operation and apply the operation. | |
return $this->getToolkitOperation($operation)->apply($arguments); | |
} | |
catch (PluginNotFoundException $e) { | |
$this->logger->error("The selected image handling toolkit '@toolkit' can not process operation '@operation'.", array('@toolkit' => $this->getPluginId(), '@operation' => $operation)); | |
return FALSE; | |
} | |
catch (\InvalidArgumentException $e) { | |
$this->logger->warning($e->getMessage(), array()); | |
return FALSE; | |
} | |
} | |
} |