public function DesaturateImageEffect::applyEffect in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect::applyEffect()
2. 10 core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect::applyEffect()

Applies an image effect to the image object.

Parameters

\Drupal\Core\Image\ImageInterface $image: An image file object.

Return value

bool TRUE on success. FALSE if unable to perform the image effect on the image.

Overrides ImageEffectInterface::applyEffect

File

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

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