You are here

Home » API reference » Drupal 10 » ImageToolkitOperationBase.php » ImageToolkitOperationBase

abstract protected function ImageToolkitOperationBase::arguments in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationBase.php \Drupal\Core\ImageToolkit\ImageToolkitOperationBase::arguments()
  2. 9 core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationBase.php \Drupal\Core\ImageToolkit\ImageToolkitOperationBase::arguments()

Returns the definition of the operation arguments.

Image toolkit operation implementers must implement this method to "document" their operation, thus also if no arguments are expected.

Return value

array An array whose keys are the names of the arguments (e.g. "width", "degrees") and each value is an associative array having the following keys:

  • description: A string with the argument description. This is used only internally for documentation purposes, so it does not need to be translatable.
  • required: (optional) A boolean indicating if this argument should be provided or not. Defaults to TRUE.
  • default: (optional) When the argument is set to "required" = FALSE, this must be set to a default value. Ignored for "required" = TRUE arguments.
8 methods override ImageToolkitOperationBase::arguments()
Convert::arguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php
Returns the definition of the operation arguments.
CreateNew::arguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/CreateNew.php
Returns the definition of the operation arguments.
Crop::arguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php
Returns the definition of the operation arguments.
Desaturate::arguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php
Returns the definition of the operation arguments.
OperationBase::arguments in core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/OperationBase.php
Returns the definition of the operation arguments.

... See full list

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationBase.php, line 86

Class

ImageToolkitOperationBase
Provides a base class for image toolkit operation plugins.

Namespace

Drupal\Core\ImageToolkit

Code

protected abstract function arguments();