class DesaturateImageEffect

Same name and namespace in other branches

9 core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect
8.9.x core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect
10 core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect

Desaturates (grayscale) an image resource.

Attributes

#[ImageEffect(id: "image_desaturate", label: new TranslatableMarkup("Desaturate"), description: new TranslatableMarkup("Desaturate converts an image to grayscale."))]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Plugin\ConfigurablePluginBase extends \Drupal\Component\Plugin\ConfigurableInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\image\ImageEffectBase extends \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\ConfigurablePluginBase
      - class \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect implements \Drupal\image\ImageEffectBase

Expanded class hierarchy of DesaturateImageEffect

File

core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php, line 13

Namespace

Drupal\image\Plugin\ImageEffect

View on git.drupalcode.org

View source

class DesaturateImageEffect extends ImageEffectBase {
  
  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image->desaturate()) {
      $this->logger
        ->error('Image desaturate failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', [
        '%toolkit' => $image->getToolkitId(),
        '%path' => $image->getSource(),
        '%mimetype' => $image->getMimeType(),
        '%dimensions' => $image->getWidth() . 'x' . $image->getHeight(),
      ]);
      return FALSE;
    }
    return TRUE;
  }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	Overrides
ConfigurableTrait::$configuration		protected	property	Configuration information passed into the plugin.
ConfigurableTrait::defaultConfiguration		public	function	Gets default configuration for this plugin.		19
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			3
DependencySerializationTrait::__wakeup		public	function			3
DesaturateImageEffect::applyEffect		public	function	Applies an image effect to the image object.	Overrides ImageEffectInterface::applyEffect
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	1
ImageEffectBase::getConfiguration		public	function	Gets this plugin's configuration.	Overrides ConfigurableTrait::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 ConfigurableTrait::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	Constructs a \Drupal\Component\Plugin\PluginBase object.	Overrides ConfigurablePluginBase::__construct
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::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	Deprecated	public	function	Determines if the plugin is configurable.
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.

Breadcrumb