Same name and namespace in other branches

1. 9 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/ScaleAndCrop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\ScaleAndCrop::validateArguments()
2. 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/ScaleAndCrop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\ScaleAndCrop::validateArguments()
3. 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/ScaleAndCrop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\ScaleAndCrop::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/ScaleAndCrop.php, line 47

Class

ScaleAndCrop

Defines GD2 Scale and crop operation.

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

Code

protected function validateArguments(array $arguments) {
  $actualWidth = $this->getToolkit()
    ->getWidth();
  $actualHeight = $this->getToolkit()
    ->getHeight();
  $scaleFactor = max($arguments['width'] / $actualWidth, $arguments['height'] / $actualHeight);
  $arguments['x'] = isset($arguments['x']) ? (int) round($arguments['x']) : (int) round(($actualWidth * $scaleFactor - $arguments['width']) / 2);
  $arguments['y'] = isset($arguments['y']) ? (int) round($arguments['y']) : (int) round(($actualHeight * $scaleFactor - $arguments['height']) / 2);
  $arguments['resize'] = [
    'width' => (int) round($actualWidth * $scaleFactor),
    'height' => (int) round($actualHeight * $scaleFactor),
  ];
  // Fail when width or height are 0 or negative.
  if ($arguments['width'] <= 0) {
    throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'scale_and_crop' operation");
  }
  if ($arguments['height'] <= 0) {
    throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'scale_and_crop' operation");
  }
  return $arguments;
}

---