class DesaturateImageEffect

Desaturates (grayscale) an image resource.

Plugin annotation

@ImageEffect(
  id = "image_desaturate",
  label = @Translation("Desaturate"),
  description = @Translation("Desaturate converts an image to grayscale.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \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 extends \Drupal\Component\Plugin\PluginBase
    • class \Drupal\image\ImageEffectBase implements \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
      • class \Drupal\image\Plugin\ImageEffect\DesaturateImageEffect extends \Drupal\image\ImageEffectBase

Expanded class hierarchy of DesaturateImageEffect

File

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

Namespace

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