abstract class ImageToolkitBase in Zircon Profile 8

Same name and namespace in other branches

8.0 core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php \Drupal\Core\ImageToolkit\ImageToolkitBase

Provides a base class for image toolkit plugins.

View source

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;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	90
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ImageToolkitBase::$configFactory	protected	property	The config factory.
ImageToolkitBase::$logger	protected	property	A logger instance.
ImageToolkitBase::$operationManager	protected	property	The image toolkit operation manager.
ImageToolkitBase::$source	protected	property	Path of the image file.
ImageToolkitBase::apply	public	function	Applies a toolkit operation to an image. Overrides ImageToolkitInterface::apply	1
ImageToolkitBase::getRequirements	public	function	Gets toolkit requirements in a format suitable for hook_requirements(). Overrides ImageToolkitInterface::getRequirements	1
ImageToolkitBase::getSource	public	function	Gets the source path of the image file. Overrides ImageToolkitInterface::getSource
ImageToolkitBase::getToolkitOperation	protected	function	Gets a toolkit operation plugin instance.
ImageToolkitBase::setSource	public	function	Sets the source path of the image file. Overrides ImageToolkitInterface::setSource
ImageToolkitBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
ImageToolkitBase::__construct	public	function	Constructs an ImageToolkitBase object. Overrides PluginBase::__construct	2
ImageToolkitInterface::getHeight	public	function	Returns the height of the image.	2
ImageToolkitInterface::getMimeType	public	function	Returns the MIME type of the image file.	2
ImageToolkitInterface::getSupportedExtensions	public static	function	Returns a list of image file extensions supported by the toolkit.	2
ImageToolkitInterface::getWidth	public	function	Returns the width of the image.	2
ImageToolkitInterface::isAvailable	public static	function	Verifies that the Image Toolkit is set up correctly.	2
ImageToolkitInterface::isValid	public	function	Checks if the image is valid.	2
ImageToolkitInterface::parseFile	public	function	Determines if a file contains a valid image.	2
ImageToolkitInterface::save	public	function	Writes an image resource to a destination file.	2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	23
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	21
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

abstract class ImageToolkitBase in Zircon Profile 8

Hierarchy

See also

File

Namespace

Members

API Navigation