class Crop in Drupal 10

Defines GD2 Crop operation.

Plugin annotation

@ImageToolkitOperation(
  id = "gd_crop",
  toolkit = "gd",
  operation = "crop",
  label = @Translation("Crop"),
  description = @Translation("Crops an image to a rectangle specified by the given dimensions.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
      • class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
        • class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop

3 string references to 'Crop'

ImageTest::testCrop in core/tests/Drupal/Tests/Core/Image/ImageTest.php

Tests \Drupal\Core\Image\Image::crop().

ImageTest::testCropHeight in core/tests/Drupal/Tests/Core/Image/ImageTest.php

Tests \Drupal\Core\Image\Image::crop().

ImageTest::testCropWidth in core/tests/Drupal/Tests/Core/Image/ImageTest.php

Tests \Drupal\Core\Image\Image::crop().

File

core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php, line 16

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd

class Crop extends GDImageToolkitOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'x' => [
        'description' => 'The starting x offset at which to start the crop, in pixels',
      ],
      'y' => [
        'description' => 'The starting y offset at which to start the crop, in pixels',
      ],
      'width' => [
        'description' => 'The width of the cropped area, in pixels',
        'required' => FALSE,
        'default' => NULL,
      ],
      'height' => [
        'description' => 'The height of the cropped area, in pixels',
        'required' => FALSE,
        'default' => NULL,
      ],
    ];
  }

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

    // 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;
  }

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

    // Create a new resource of the required dimensions, and copy and resize
    // the original resource on it with resampling. Destroy the original
    // resource upon success.
    $original_resource = $this
      ->getToolkit()
      ->getResource();
    $data = [
      'width' => $arguments['width'],
      'height' => $arguments['height'],
      'extension' => image_type_to_extension($this
        ->getToolkit()
        ->getType(), FALSE),
      'transparent_color' => $this
        ->getToolkit()
        ->getTransparentColor(),
      'is_temp' => TRUE,
    ];
    if ($this
      ->getToolkit()
      ->apply('create_new', $data)) {
      if (imagecopyresampled($this
        ->getToolkit()
        ->getResource(), $original_resource, 0, 0, $arguments['x'], $arguments['y'], $arguments['width'], $arguments['height'], $arguments['width'], $arguments['height'])) {
        imagedestroy($original_resource);
        return TRUE;
      }
      else {

        // In case of failure, destroy the temporary resource and restore
        // the original one.
        imagedestroy($this
          ->getToolkit()
          ->getResource());
        $this
          ->getToolkit()
          ->setResource($original_resource);
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Crop::arguments	protected	function	Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
Crop::execute	protected	function	Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
Crop::validateArguments	protected	function	Validates the arguments. Overrides ImageToolkitOperationBase::validateArguments
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
GDImageToolkitOperationBase::getToolkit	protected	function	The correctly typed image toolkit for GD operations. Overrides ImageToolkitOperationBase::getToolkit
ImageToolkitOperationBase::$logger	protected	property	A logger instance.
ImageToolkitOperationBase::$toolkit	protected	property	The image toolkit.
ImageToolkitOperationBase::apply	final public	function
ImageToolkitOperationBase::prepareArguments	protected	function	Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::__construct	public	function	Constructs an image toolkit operation plugin.
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.