protected function Replace::validateArguments in Image Replace 8

Same name in this branch

1. 8 src/Plugin/ImageToolkit/Operation/gd/Replace.php \Drupal\image_replace\Plugin\ImageToolkit\Operation\gd\Replace::validateArguments()
2. 8 src/Plugin/ImageToolkit/Operation/imagemagick/Replace.php \Drupal\image_replace\Plugin\ImageToolkit\Operation\imagemagick\Replace::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.

Overrides ImageToolkitOperationBase::validateArguments

File

src/Plugin/ImageToolkit/Operation/gd/Replace.php, line 36

Class

Replace

Defines GD2 image_replace operation.

Namespace

Drupal\image_replace\Plugin\ImageToolkit\Operation\gd

Code

protected function validateArguments(array $arguments) {
  if (!($arguments['replacement_image'] instanceof ImageInterface || !$arguments['replacement_image']
    ->getToolkit() instanceof GDToolkit)) {
    throw new \InvalidArgumentException("Invalid replacement image specified for the 'image_replace' operation.");
  }
  return $arguments;
}