class ImageToolkitBase

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php \Drupal\Core\ImageToolkit\ImageToolkitBase
  2. 8.9.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php \Drupal\Core\ImageToolkit\ImageToolkitBase
  3. 11.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php \Drupal\Core\ImageToolkit\ImageToolkitBase

Provides a base class for image toolkit plugins.

Hierarchy

Expanded class hierarchy of ImageToolkitBase

See also

\Drupal\Core\ImageToolkit\Annotation\ImageToolkit

\Drupal\Core\ImageToolkit\ImageToolkitInterface

\Drupal\Core\ImageToolkit\ImageToolkitManager

Plugin API

2 files declare their use of ImageToolkitBase
GDToolkit.php in core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php
TestToolkit.php in core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/TestToolkit.php

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php, line 19

Namespace

Drupal\Core\ImageToolkit
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 [];
  }
  
  /**
   * 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 = []) {
    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'.", [
        '@toolkit' => $this->getPluginId(),
        '@operation' => $operation,
      ]);
      return FALSE;
    } catch (\Throwable $t) {
      $this->logger
        ->warning("The image toolkit '@toolkit' failed processing '@operation' for image '@image'. Reported error: @class - @message", [
        '@toolkit' => $this->getPluginId(),
        '@operation' => $operation,
        '@image' => $this->getSource(),
        '@class' => get_class($t),
        '@message' => $t->getMessage(),
      ]);
      return FALSE;
    }
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 131
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. 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
PluginFormInterface::buildConfigurationForm public function Form constructor. 31
PluginFormInterface::submitConfigurationForm public function Form submission handler. 29
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.