DesaturateImageEffect.php

Same filename in other branches
  1. 8.9.x core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php
  2. 10 core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php
  3. 11.x core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php

Namespace

Drupal\image\Plugin\ImageEffect

File

core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php

View source
<?php

namespace Drupal\image\Plugin\ImageEffect;

use Drupal\Core\Image\ImageInterface;
use Drupal\image\ImageEffectBase;

/**
 * Desaturates (grayscale) an image resource.
 *
 * @ImageEffect(
 *   id = "image_desaturate",
 *   label = @Translation("Desaturate"),
 *   description = @Translation("Desaturate converts an image to grayscale.")
 * )
 */
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;
    }

}

Classes

Title Deprecated Summary
DesaturateImageEffect Desaturates (grayscale) an image resource.

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