class Crop
Same name in other branches
- 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop
- 10 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop
- 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop
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 \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase extends \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop extends \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase extends \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
- class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Crop
8 string references to 'Crop'
- ImageEffectsTest::testCropEffect in core/
modules/ image/ tests/ src/ Kernel/ ImageEffectsTest.php - Tests the 'image_crop' effect.
- 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().
- ScaleAndCrop::execute in core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ ScaleAndCrop.php - Performs the actual manipulation on the image.
File
-
core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Crop.php, line 16
Namespace
Drupal\system\Plugin\ImageToolkit\Operation\gdView source
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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | |
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 | Applies a toolkit specific operation to an image. | Overrides ImageToolkitOperationInterface::apply | |
ImageToolkitOperationBase::prepareArguments | protected | function | Checks for required arguments and adds optional argument defaults. | ||
ImageToolkitOperationBase::__construct | public | function | Constructs an image toolkit operation plugin. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.