protected function ImageToolkitOperationBase::validateArguments in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationBase.php \Drupal\Core\ImageToolkit\ImageToolkitOperationBase::validateArguments()

Validates the arguments.

Image toolkit operation implementers should place any argument validation in this method, throwing an InvalidArgumentException when an error is encountered.

Validation typically includes things like:

• Checking that width and height are not negative.
• Checking that a color value is indeed a color.

But validation may also include correcting the arguments, e.g:

• Casting arguments to the correct type.
• Rounding pixel values to an integer.

This base implementation just returns the array of arguments and thus does not need to be called by overriding methods.

Parameters

array $arguments: An associative array of arguments to be used by the toolkit operation.

Return value

array The validated and corrected arguments array.

Throws

\InvalidArgumentException If one or more of the arguments are not valid.

\Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException If the plugin does not define a default for an optional argument.

1 call to ImageToolkitOperationBase::validateArguments()

ImageToolkitOperationBase::apply in core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationBase.php

Applies a toolkit specific operation to an image.

6 methods override ImageToolkitOperationBase::validateArguments()

Convert::validateArguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php

Validates the arguments.

CreateNew::validateArguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/CreateNew.php

Validates the arguments.

Crop::validateArguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php

Validates the arguments.

Resize::validateArguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php

Validates the arguments.

Rotate::validateArguments in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Rotate.php

Validates the arguments.

... See full list

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationBase.php, line 162

Class

ImageToolkitOperationBase

Provides a base class for image toolkit operation plugins.

Namespace

Drupal\Core\ImageToolkit

Code

protected function validateArguments(array $arguments) {
  return $arguments;
}