class Desaturate

Same name and namespace in other branches

8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Desaturate
10 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Desaturate
11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Desaturate

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 extends \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 implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase extends \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase implements \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
      - class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Desaturate implements \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase

Expanded class hierarchy of Desaturate

7 string references to 'Desaturate'

ImageEffectsTest::testDesaturateEffect in core/modules/image/tests/src/Kernel/ImageEffectsTest.php: Tests the 'image_desaturate' effect.
ImageTest::testDesaturate in core/tests/Drupal/Tests/Core/Image/ImageTest.php: Tests \Drupal\Core\Image\Image::desaturate().
ToolkitGdTest::providerTestImageFiles in core/tests/Drupal/KernelTests/Core/Image/ToolkitGdTest.php: Data provider for ::testManipulations().
ToolkitGdTest::testManipulations in core/tests/Drupal/KernelTests/Core/Image/ToolkitGdTest.php: Tests height, width and color for the corners for the final images.
ToolkitTestBase::assertToolkitOperationsCalled in core/tests/Drupal/FunctionalTests/Image/ToolkitTestBase.php: Tests that only allowed image toolkit operations are called.

... See full list

File

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

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

View on git.drupalcode.org

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

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function			2
DependencySerializationTrait::__wakeup	public	function	#[\ReturnTypeWillChange]		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	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.	Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.		27
MessengerTrait::messenger	public	function	Gets the messenger.		27
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.		1
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	Gets the base_plugin_id of the plugin instance.	Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance.	Overrides PluginInspectionInterface::getPluginId
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.		2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

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

Breadcrumb