protected function Composite::arguments in Imagick 8

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.

Overrides ImageToolkitOperationBase::arguments

File

src/Plugin/ImageToolkit/Operation/imagick/Composite.php, line 25

Class

Composite

Defines imagick blur operation.

Namespace

Drupal\imagick\Plugin\ImageToolkit\Operation\imagick

Code

protected function arguments() {
  return [
    'path' => [
      'description' => 'Path to the composite image',
    ],
    'composite' => [
      'description' => 'Composite operator',
    ],
    'x' => [
      'description' => 'The column offset of the composited image',
    ],
    'y' => [
      'description' => 'he row offset of the composited image',
    ],
    'channel' => [
      'description' => 'Provide any channel constant that is valid for your channel mode. It is possible to apply more than one channel.',
    ],
  ];
}