class DesaturateImageEffect

Same name and namespace in other branches
  1. 9 core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect
  2. 8.9.x core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect
  3. 11.x core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect

Desaturates (grayscale) an image resource.

Hierarchy

Expanded class hierarchy of DesaturateImageEffect

File

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

Namespace

Drupal\image\Plugin\ImageEffect
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 Modifiers Object type Summary Overriden Title Overrides
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
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
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.