protected function Crop::validateArguments in ImageMagick 8.2

Same name and namespace in other branches

1. 8.3 src/Plugin/ImageToolkit/Operation/imagemagick/Crop.php \Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick\Crop::validateArguments()
2. 8 src/Plugin/ImageToolkit/Operation/imagemagick/Crop.php \Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick\Crop::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/imagemagick/Crop.php, line 45

Class

Crop

Defines imagemagick Crop operation.

Namespace

Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick

Code

protected function validateArguments(array $arguments) {

  // Fail if no dimensions available for current image.
  if (is_null($this
    ->getToolkit()
    ->getWidth()) || is_null($this
    ->getToolkit()
    ->getHeight())) {

    // @todo \InvalidArgumentException is incorrect, but other exceptions
    // would not be managed by toolkits that implement ImageToolkitBase.
    // Change to \RuntimeException when
    // https://www.drupal.org/project/drupal/issues/2583041 is committed.
    throw new \InvalidArgumentException("No image dimensions available for the image '{$this->getPluginDefinition()['operation']}' operation");
  }

  // Assure at least one dimension.
  if (empty($arguments['width']) && empty($arguments['height'])) {
    throw new \InvalidArgumentException("At least one dimension ('width' or 'height') must be provided to the image 'crop' operation");
  }

  // Preserve aspect.
  $aspect = $this
    ->getToolkit()
    ->getHeight() / $this
    ->getToolkit()
    ->getWidth();
  $arguments['height'] = empty($arguments['height']) ? $arguments['width'] * $aspect : $arguments['height'];
  $arguments['width'] = empty($arguments['width']) ? $arguments['height'] / $aspect : $arguments['width'];

  // Assure integers for all arguments.
  foreach ([
    'x',
    'y',
    'width',
    'height',
  ] as $key) {
    $arguments[$key] = (int) round($arguments[$key]);
  }

  // Fail when width or height are 0 or negative.
  if ($arguments['width'] <= 0) {
    throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'crop' operation");
  }
  if ($arguments['height'] <= 0) {
    throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'crop' operation");
  }
  return $arguments;
}