Provides a base class for image effects.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
See also
\Drupal\image\Annotation\ImageEffect
\Drupal\image\ImageEffectInterface
\Drupal\image\ConfigurableImageEffectInterface
\Drupal\image\ConfigurableImageEffectBase
\Drupal\image\ImageEffectManager
Plugin API
File
- core/modules/image/src/ImageEffectBase.php, line 20
Namespace
Drupal\image
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| 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 ConfigurablePluginInterface::defaultConfiguration |
| ImageEffectBase::getConfiguration | public | function | Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration |
| ImageEffectBase::getDerivativeExtension | public | function | Returns the extension the derivative would have have after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension |
| ImageEffectBase::getSummary | public | function | Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectInterface::getSummary |
| 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 ConfigurablePluginInterface::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 |
| ImageEffectBase::__construct | public | function | Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct |
| ImageEffectInterface::applyEffect | public | function | Applies an image effect to the image object. |
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. |
| 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 |
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
| 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. |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Please login to continue.