You are here

Home » API reference » Image Effects 8 » ImagemagickArgumentsTrait.php

trait ImagemagickArgumentsTrait in Image Effects 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/ImageToolkit/Operation/ImagemagickArgumentsTrait.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\ImagemagickArgumentsTrait
  2. 8.2 src/Plugin/ImageToolkit/Operation/ImagemagickArgumentsTrait.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\ImagemagickArgumentsTrait

Base trait for ImageMagick arguments operations.

Hierarchy

2 files declare their use of ImagemagickArgumentsTrait
ImagemagickArguments.php in src/Plugin/ImageToolkit/Operation/gd/ImagemagickArguments.php
ImagemagickArguments.php in src/Plugin/ImageToolkit/Operation/imagemagick/ImagemagickArguments.php

File

src/Plugin/ImageToolkit/Operation/ImagemagickArgumentsTrait.php, line 8

Namespace

Drupal\image_effects\Plugin\ImageToolkit\Operation
View source 
trait ImagemagickArgumentsTrait {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'command_line' => [
        'description' => 'Command line arguments.',
      ],
      'width' => [
        'description' => 'Width of image after operation.',
      ],
      'height' => [
        'description' => 'Height of image after operation.',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function validateArguments(array $arguments) {

    // Ensure 'width' is NULL or a positive integer.
    $arguments['width'] = $arguments['width'] !== NULL ? (int) $arguments['width'] : NULL;
    if ($arguments['width'] !== NULL && $arguments['width'] <= 0) {
      throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'imagemagick_arguments' operation");
    }

    // Ensure 'height' is NULL or a positive integer.
    $arguments['height'] = $arguments['height'] !== NULL ? (int) $arguments['height'] : NULL;
    if ($arguments['height'] !== NULL && $arguments['height'] <= 0) {
      throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'imagemagick_arguments' operation");
    }
    return $arguments;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ImagemagickArgumentsTrait::arguments protected function
ImagemagickArgumentsTrait::validateArguments protected function