function Resize::validateArguments
Same name and namespace in other branches
- 9 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize::validateArguments()
- 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize::validateArguments()
- 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize::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
1 method overrides Resize::validateArguments()
- Scale::validateArguments in core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Scale.php - Validates the arguments.
File
-
core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Resize.php, line 37
Class
- Resize
- Defines GD2 resize operation.
Namespace
Drupal\system\Plugin\ImageToolkit\Operation\gdCode
protected function validateArguments(array $arguments) {
// Assure integers for all arguments.
$arguments['width'] = (int) round($arguments['width']);
$arguments['height'] = (int) round($arguments['height']);
// Fail when width or height are 0 or negative.
if ($arguments['width'] <= 0) {
throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'resize' operation");
}
if ($arguments['height'] <= 0) {
throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'resize' operation");
}
return $arguments;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.