protected function ScaleAndCrop::arguments in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/ScaleAndCrop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\ScaleAndCrop::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.

Overrides ImageToolkitOperationBase::arguments

File

core/modules/system/src/Plugin/ImageToolkit/Operation/gd/ScaleAndCrop.php, line 21

Class

ScaleAndCrop

Defines GD2 Scale and crop operation.

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

Code

protected function arguments() {
  return [
    'x' => [
      'description' => 'The horizontal offset for the start of the crop, in pixels',
      'required' => FALSE,
      'default' => NULL,
    ],
    'y' => [
      'description' => 'The vertical offset for the start the crop, in pixels',
      'required' => FALSE,
      'default' => NULL,
    ],
    'width' => [
      'description' => 'The target width, in pixels',
    ],
    'height' => [
      'description' => 'The target height, in pixels',
    ],
  ];
}