class Desaturate in Drupal 10

Defines GD2 Desaturate operation.

Plugin annotation

@ImageToolkitOperation(
  id = "gd_desaturate",
  toolkit = "gd",
  operation = "desaturate",
  label = @Translation("Desaturate"),
  description = @Translation("Converts an image to grayscale.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
      • class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
        • class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Desaturate

2 string references to 'Desaturate'

ImageTest::testDesaturate in core/tests/Drupal/Tests/Core/Image/ImageTest.php

Tests \Drupal\Core\Image\Image::desaturate().

UpdatePathTestBaseFilledTest::testUpdatedSite in core/modules/system/tests/src/Functional/UpdateSystem/UpdatePathTestBaseFilledTest.php

Tests that the content and configuration were properly updated.

File

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

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

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

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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
ImageToolkitOperationBase::prepareArguments	protected	function	Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::validateArguments	protected	function	Validates the arguments.
ImageToolkitOperationBase::__construct	public	function	Constructs an image toolkit operation plugin.
MessengerTrait::$messenger	protected	property	The messenger.	16
MessengerTrait::messenger	public	function	Gets the messenger.	16
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		1
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.