protected function CreateNew::arguments in Drupal 9

Same name and namespace in other branches

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

Class

CreateNew

Defines GD2 create_new image operation.

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

Code

protected function arguments() {
  return [
    'width' => [
      'description' => 'The width of the image, in pixels',
    ],
    'height' => [
      'description' => 'The height of the image, in pixels',
    ],
    'extension' => [
      'description' => 'The extension of the image file (e.g. png, gif, etc.)',
      'required' => FALSE,
      'default' => 'png',
    ],
    'transparent_color' => [
      'description' => 'The RGB hex color for GIF transparency',
      'required' => FALSE,
      'default' => '#ffffff',
    ],
    'is_temp' => [
      'description' => 'If TRUE, this operation is being used to create a temporary image by another GD operation. After performing its function, the caller is responsible for destroying the original GD resource.',
      'required' => FALSE,
      'default' => FALSE,
    ],
  ];
}