You are here

abstract class ImageEffectsPluginBase in Image Effects 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/ImageEffectsPluginBase.php \Drupal\image_effects\Plugin\ImageEffectsPluginBase
  2. 8.2 src/Plugin/ImageEffectsPluginBase.php \Drupal\image_effects\Plugin\ImageEffectsPluginBase

Base image_effects plugin.

Hierarchy

Expanded class hierarchy of ImageEffectsPluginBase

6 files declare their use of ImageEffectsPluginBase
Basic.php in src/Plugin/image_effects/FontSelector/Basic.php
Basic.php in src/Plugin/image_effects/ImageSelector/Basic.php
Dropdown.php in src/Plugin/image_effects/ImageSelector/Dropdown.php
Farbtastic.php in src/Plugin/image_effects/ColorSelector/Farbtastic.php
HtmlColor.php in src/Plugin/image_effects/ColorSelector/HtmlColor.php

... See full list

File

src/Plugin/ImageEffectsPluginBase.php, line 14

Namespace

Drupal\image_effects\Plugin
View source
abstract class ImageEffectsPluginBase extends PluginBase implements ImageEffectsPluginBaseInterface {

  /**
   * The image_effects plugin type.
   *
   * @var string
   */
  protected $pluginType;

  /**
   * Configuration object for image_effects.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The image_effects logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a ImageEffectsPluginBase 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 mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Psr\Log\LoggerInterface $logger
   *   The image_effects logger.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, LoggerInterface $logger) {
    $this->config = $config_factory
      ->getEditable('image_effects.settings');
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->pluginType = $configuration['plugin_type'];
    $config = $this->config
      ->get($this->pluginType . '.plugin_settings.' . $plugin_id);
    $this
      ->setConfiguration(array_merge($this
      ->defaultConfiguration(), is_array($config) ? $config : []));
    $this->logger = $logger;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration;
  }

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

  /**
   * {@inheritdoc}
   */
  public static function isAvailable() {
    return TRUE;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, array $ajax_settings = []) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function selectionElement(array $options = []) {
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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
ImageEffectsPluginBase::$config protected property Configuration object for image_effects.
ImageEffectsPluginBase::$logger protected property The image_effects logger.
ImageEffectsPluginBase::$pluginType protected property The image_effects plugin type.
ImageEffectsPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
ImageEffectsPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectsPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
ImageEffectsPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration 2
ImageEffectsPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
ImageEffectsPluginBase::getType public function Get the image_effects plugin type. Overrides ImageEffectsPluginBaseInterface::getType
ImageEffectsPluginBase::isAvailable public static function Determines if plugin can be used. Overrides ImageEffectsPluginBaseInterface::isAvailable 1
ImageEffectsPluginBase::selectionElement public function Return a form element to select the plugin content. Overrides ImageEffectsPluginBaseInterface::selectionElement 6
ImageEffectsPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
ImageEffectsPluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ImageEffectsPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ImageEffectsPluginBase::__construct public function Constructs a ImageEffectsPluginBase object. Overrides PluginBase::__construct 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.