function DesaturateImageEffect::applyEffect

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

Overrides ImageEffectInterface::applyEffect

File

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

Class

DesaturateImageEffect
Desaturates (grayscale) an image resource.

Namespace

Drupal\image\Plugin\ImageEffect

Code

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;
}

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