Desaturate.php

Same filename in other branches
  1. 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php
  2. 10 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php
  3. 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

File

core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php

View source
<?php

namespace Drupal\system\Plugin\ImageToolkit\Operation\gd;


/**
 * Defines GD2 Desaturate operation.
 *
 * @ImageToolkitOperation(
 *   id = "gd_desaturate",
 *   toolkit = "gd",
 *   operation = "desaturate",
 *   label = @Translation("Desaturate"),
 *   description = @Translation("Converts an image to grayscale.")
 * )
 */
class Desaturate extends GDImageToolkitOperationBase {
    
    /**
     * {@inheritdoc}
     */
    protected function arguments() {
        // This operation does not use any parameters.
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function execute(array $arguments) {
        // PHP installations using non-bundled GD do not have imagefilter.
        if (!function_exists('imagefilter')) {
            $this->logger
                ->notice("The image '@file' could not be desaturated because the imagefilter() function is not available in this PHP installation.", [
                '@file' => $this->getToolkit()
                    ->getSource(),
            ]);
            return FALSE;
        }
        return imagefilter($this->getToolkit()
            ->getResource(), IMG_FILTER_GRAYSCALE);
    }

}

Classes

Title Deprecated Summary
Desaturate Defines GD2 Desaturate operation.

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