protected function Crop::arguments in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop::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/Crop.php, line 26

Contains \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop.

Class

Crop

Defines GD2 Crop operation.

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

Code

protected function arguments() {
  return array(
    'x' => array(
      'description' => 'The starting x offset at which to start the crop, in pixels',
    ),
    'y' => array(
      'description' => 'The starting y offset at which to start the crop, in pixels',
    ),
    'width' => array(
      'description' => 'The width of the cropped area, in pixels',
      'required' => FALSE,
      'default' => NULL,
    ),
    'height' => array(
      'description' => 'The height of the cropped area, in pixels',
      'required' => FALSE,
      'default' => NULL,
    ),
  );
}