class ConfigurableImageEffectBase

Same name and namespace in other branches
  1. 11.x core/modules/image/src/ConfigurableImageEffectBase.php \Drupal\image\ConfigurableImageEffectBase
  2. 10 core/modules/image/src/ConfigurableImageEffectBase.php \Drupal\image\ConfigurableImageEffectBase
  3. 9 core/modules/image/src/ConfigurableImageEffectBase.php \Drupal\image\ConfigurableImageEffectBase
  4. 8.9.x core/modules/image/src/ConfigurableImageEffectBase.php \Drupal\image\ConfigurableImageEffectBase

Provides a base class for configurable image effects.

Hierarchy

Expanded class hierarchy of ConfigurableImageEffectBase

See also

\Drupal\image\Annotation\ImageEffect

\Drupal\image\ConfigurableImageEffectInterface

\Drupal\image\ImageEffectInterface

\Drupal\image\ImageEffectBase

\Drupal\image\ImageEffectManager

Plugin API

4 files declare their use of ConfigurableImageEffectBase
AjaxTestImageEffect.php in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php
ConvertImageEffect.php in core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php
ResizeImageEffect.php in core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php
RotateImageEffect.php in core/modules/image/src/Plugin/ImageEffect/RotateImageEffect.php

File

View on git.drupalcode.org

core/modules/image/src/ConfigurableImageEffectBase.php, line 17

Namespace

Drupal\image
View source 
abstract class ConfigurableImageEffectBase extends ImageEffectBase implements ConfigurableImageEffectInterface {
  
  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AutowiredInstanceTrait::createInstanceAutowired public static function Instantiates a new instance of the implementing class using autowiring.
AutowiredInstanceTrait::getAutowireArguments private static function Resolves arguments for a method using autowiring.
ConfigurableImageEffectBase::submitConfigurationForm public function Overrides PluginFormInterface::submitConfigurationForm 4
ConfigurableImageEffectBase::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm 2
ConfigurableTrait::$configuration protected property Configuration information passed into the plugin.
ConfigurableTrait::defaultConfiguration public function Gets default configuration for this plugin. 15
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 2
DependencySerializationTrait::__wakeup public function 2
ImageEffectBase::$logger protected property A logger instance.
ImageEffectBase::$uuid protected property The image effect ID.
ImageEffectBase::$weight protected property The weight of the image effect.
ImageEffectBase::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::getConfiguration public function Overrides ConfigurableTrait::getConfiguration
ImageEffectBase::getDerivativeExtension public function Overrides ImageEffectInterface::getDerivativeExtension 1
ImageEffectBase::getSummary public function Overrides ImageEffectInterface::getSummary 3
ImageEffectBase::getUuid public function Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Overrides ImageEffectInterface::label
ImageEffectBase::onCollectionDependencyRemoval public function Overrides RemovableDependentPluginInterface::onCollectionDependencyRemoval
ImageEffectBase::setConfiguration public function Overrides ConfigurableTrait::setConfiguration
ImageEffectBase::setWeight public function Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function Overrides ConfigurablePluginBase::__construct
ImageEffectInterface::applyEffect public function Applies an image effect to the image object. 7
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::create public static function Instantiates a new instance of the implementing class using autowiring. 64
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Overrides PluginInspectionInterface::getPluginId
PluginFormInterface::buildConfigurationForm public function Form constructor. 45
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1

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