class ConfigurableImageEffectBase

Same name in other branches
  1. 9 core/modules/image/src/ConfigurableImageEffectBase.php \Drupal\image\ConfigurableImageEffectBase
  2. 8.9.x core/modules/image/src/ConfigurableImageEffectBase.php \Drupal\image\ConfigurableImageEffectBase
  3. 10 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

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 Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigurableImageEffectBase::submitConfigurationForm public function 4
ConfigurableImageEffectBase::validateConfigurationForm 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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 4
ImageEffectBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension public function Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension 1
ImageEffectBase::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectInterface::getSummary 3
ImageEffectBase::getUuid public function Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight public function Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Determines the dimensions of the styled image. Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function
ImageEffectInterface::applyEffect public function Applies an image effect to the image object. 7
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.