function Convert::validateArguments
Same name and namespace in other branches
- 9 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert::validateArguments()
- 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert::validateArguments()
- 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert::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.
Overrides ImageToolkitOperationBase::validateArguments
File
-
core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Convert.php, line 34
Class
- Convert
- Defines GD2 convert operation.
Namespace
Drupal\system\Plugin\ImageToolkit\Operation\gdCode
protected function validateArguments(array $arguments) {
if (!in_array($arguments['extension'], $this->getToolkit()
->getSupportedExtensions())) {
throw new \InvalidArgumentException("Invalid extension ({$arguments['extension']}) specified for the image 'convert' operation");
}
return $arguments;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.