protected function AddWatermark::arguments in Basic Watermark 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/gd/AddWatermark.php, line 23

Class

AddWatermark

Defines GD2 Add Watermark operation.

Namespace

Drupal\basic_watermark\Plugin\ImageToolkit\Operation\gd

Code

protected function arguments() {
  return [
    'watermark_path' => [
      'description' => 'The path to the watermark image',
    ],
    'apply_type' => [
      'description' => 'How to apply the watermark, repeat until it covers the whole image or once',
    ],
    'position' => [
      'description' => 'Where to put the watermark, ex: top-left, center, bottom-right',
    ],
    'margins' => [
      'description' => 'Empty area to keep around the watermark in pixels',
    ],
  ];
}