You are here

abstract class ImageAPIOptimizeProcessorBase in Image Optimize (or ImageAPI Optimize) 4.x

Same name and namespace in other branches
  1. 8.3 src/ImageAPIOptimizeProcessorBase.php \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorBase
  2. 8.2 src/ImageAPIOptimizeProcessorBase.php \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorBase

Provides a base class for image optimize processors.

Hierarchy

Expanded class hierarchy of ImageAPIOptimizeProcessorBase

See also

\Drupal\imageapi_optimize\Annotation\ImageAPIOptimizeProcessor

\Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface

\Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorInterface

\Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase

\Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager

Plugin API

3 files declare their use of ImageAPIOptimizeProcessorBase
TestProcessorAppendCharacters.php in tests/module/imageapi_optimize_module_test/src/Plugin/ImageAPIOptimizeProcessor/TestProcessorAppendCharacters.php
TestProcessorBlackPNG.php in tests/module/imageapi_optimize_module_test/src/Plugin/ImageAPIOptimizeProcessor/TestProcessorBlackPNG.php
TestProcessorFailedGreenPNG.php in tests/module/imageapi_optimize_module_test/src/Plugin/ImageAPIOptimizeProcessor/TestProcessorFailedGreenPNG.php

File

src/ImageAPIOptimizeProcessorBase.php, line 21

Namespace

Drupal\imageapi_optimize
View source
abstract class ImageAPIOptimizeProcessorBase extends PluginBase implements ImageAPIOptimizeProcessorInterface, ContainerFactoryPluginInterface {

  /**
   * The image optimize processor ID.
   *
   * @var string
   */
  protected $uuid;

  /**
   * The weight of the image optimize processor.
   *
   * @var int|string
   */
  protected $weight = '';

  /**
   * A logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The image factory.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger, ImageFactory $image_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this
      ->setConfiguration($configuration);
    $this->logger = $logger;
    $this->imageFactory = $image_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.factory')
      ->get('imageapi_optimize'), $container
      ->get('image.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return [
      '#markup' => '',
      '#processor' => [
        'id' => $this->pluginDefinition['id'],
        'label' => $this
          ->label(),
        'description' => $this->pluginDefinition['description'],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function getUuid() {
    return $this->uuid;
  }

  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this->weight = $weight;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return [
      'uuid' => $this
        ->getUuid(),
      'id' => $this
        ->getPluginId(),
      'weight' => $this
        ->getWeight(),
      'data' => $this->configuration,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $configuration += [
      'data' => [],
      'uuid' => '',
      'weight' => '',
    ];
    $this->configuration = $configuration['data'] + $this
      ->defaultConfiguration();
    $this->uuid = $configuration['uuid'];
    $this->weight = $configuration['weight'];
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   *
   */
  protected function getMimeType($uri) {
    return $this->imageFactory
      ->get($uri)
      ->getMimeType();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
ImageAPIOptimizeProcessorBase::$imageFactory protected property The image factory.
ImageAPIOptimizeProcessorBase::$logger protected property A logger instance.
ImageAPIOptimizeProcessorBase::$uuid protected property The image optimize processor ID.
ImageAPIOptimizeProcessorBase::$weight protected property The weight of the image optimize processor.
ImageAPIOptimizeProcessorBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageAPIOptimizeProcessorBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageAPIOptimizeProcessorBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ImageAPIOptimizeProcessorBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageAPIOptimizeProcessorBase::getMimeType protected function
ImageAPIOptimizeProcessorBase::getSummary public function Returns a render array summarizing the configuration of the image optimize processor. Overrides ImageAPIOptimizeProcessorInterface::getSummary
ImageAPIOptimizeProcessorBase::getUuid public function Returns the unique ID representing the image optimize processor. Overrides ImageAPIOptimizeProcessorInterface::getUuid
ImageAPIOptimizeProcessorBase::getWeight public function Returns the weight of the image optimize processor. Overrides ImageAPIOptimizeProcessorInterface::getWeight
ImageAPIOptimizeProcessorBase::label public function Returns the image optimize processor label. Overrides ImageAPIOptimizeProcessorInterface::label
ImageAPIOptimizeProcessorBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageAPIOptimizeProcessorBase::setWeight public function Sets the weight for this image optimize processor. Overrides ImageAPIOptimizeProcessorInterface::setWeight
ImageAPIOptimizeProcessorBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
ImageAPIOptimizeProcessorInterface::applyToImage public function Apply this image optimize processor to the given image. 3
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
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 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.