class Desaturate

Defines GD2 Desaturate operation.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
    - class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase extends \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
      - class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Desaturate extends \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase

Expanded class hierarchy of Desaturate

File

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

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

View source

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()
            ->getImage(), IMG_FILTER_GRAYSCALE);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Desaturate::arguments	protected	function	Returns the definition of the operation arguments.	Overrides ImageToolkitOperationBase::arguments
Desaturate::execute	protected	function	Performs the actual manipulation on the image.	Overrides ImageToolkitOperationBase::execute
GDImageToolkitOperationBase::getToolkit	protected	function	The correctly typed image toolkit for GD operations.	Overrides ImageToolkitOperationBase::getToolkit
ImageToolkitOperationBase::$logger	protected	property	A logger instance.
ImageToolkitOperationBase::$toolkit	protected	property	The image toolkit.
ImageToolkitOperationBase::apply	final public	function	Applies a toolkit specific operation to an image.	Overrides ImageToolkitOperationInterface::apply
ImageToolkitOperationBase::prepareArguments	protected	function	Checks for required arguments and adds optional argument defaults.
ImageToolkitOperationBase::validateArguments	protected	function	Validates the arguments.		6
ImageToolkitOperationBase::__construct	public	function	Constructs an image toolkit operation plugin.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.		5
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.		2