class Resize
Same name in other branches
- 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize
- 10 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize
- 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Resize.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize
Defines GD2 resize operation.
Plugin annotation
@ImageToolkitOperation(
id = "gd_resize",
toolkit = "gd",
operation = "resize",
label = @Translation("Resize"),
description = @Translation("Resizes an image to the given dimensions (ignoring aspect ratio).")
)
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\Resize 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 Resize
7 string references to 'Resize'
- ImageEffectsTest::testResizeEffect in core/
modules/ image/ tests/ src/ Kernel/ ImageEffectsTest.php - Tests the 'image_resize' effect.
- ImageTest::testFloatResize in core/
tests/ Drupal/ Tests/ Core/ Image/ ImageTest.php - Tests \Drupal\Core\Image\Image::resize().
- ImageTest::testResize in core/
tests/ Drupal/ Tests/ Core/ Image/ ImageTest.php - Tests \Drupal\Core\Image\Image::resize().
- ScaleAndCrop::execute in core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ ScaleAndCrop.php - Performs the actual manipulation on the image.
- ToolkitGdTest::providerTestImageFiles in core/
tests/ Drupal/ KernelTests/ Core/ Image/ ToolkitGdTest.php - Data provider for ::testManipulations().
File
-
core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Resize.php, line 16
Namespace
Drupal\system\Plugin\ImageToolkit\Operation\gdView source
class Resize extends GDImageToolkitOperationBase {
/**
* {@inheritdoc}
*/
protected function arguments() {
return [
'width' => [
'description' => 'The new width of the resized image, in pixels',
],
'height' => [
'description' => 'The new height of the resized image, in pixels',
],
];
}
/**
* {@inheritdoc}
*/
protected function validateArguments(array $arguments) {
// Assure integers for all arguments.
$arguments['width'] = (int) round($arguments['width']);
$arguments['height'] = (int) round($arguments['height']);
// Fail when width or height are 0 or negative.
if ($arguments['width'] <= 0) {
throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'resize' operation");
}
if ($arguments['height'] <= 0) {
throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'resize' 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, 0, 0, $arguments['width'], $arguments['height'], imagesx($original_resource), imagesy($original_resource))) {
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 |
---|---|---|---|---|---|
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 | |
Resize::arguments | protected | function | Returns the definition of the operation arguments. | Overrides ImageToolkitOperationBase::arguments | 1 |
Resize::execute | protected | function | Performs the actual manipulation on the image. | Overrides ImageToolkitOperationBase::execute | 1 |
Resize::validateArguments | protected | function | Validates the arguments. | Overrides ImageToolkitOperationBase::validateArguments | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.