class Convert
Same name in other branches
- 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
- 10 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
- 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
Defines GD2 convert operation.
Plugin annotation
@ImageToolkitOperation(
id = "gd_convert",
toolkit = "gd",
operation = "convert",
label = @Translation("Convert"),
description = @Translation("Instructs the toolkit to save the image with a specified extension.")
)
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\Convert 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 Convert
6 string references to 'Convert'
- image.schema.yml in core/
modules/ image/ config/ schema/ image.schema.yml - core/modules/image/config/schema/image.schema.yml
- ImageEffectsTest::testConvertEffect in core/
modules/ image/ tests/ src/ Kernel/ ImageEffectsTest.php - Tests the 'image_convert' effect.
- ImageTest::testConvert in core/
tests/ Drupal/ Tests/ Core/ Image/ ImageTest.php - Tests \Drupal\Core\Image\Image::convert().
- ToolkitGdTest::providerTestImageFiles in core/
tests/ Drupal/ KernelTests/ Core/ Image/ ToolkitGdTest.php - Data provider for ::testManipulations().
- ToolkitTestBase::assertToolkitOperationsCalled in core/
tests/ Drupal/ FunctionalTests/ Image/ ToolkitTestBase.php - Tests that only allowed image toolkit operations are called.
File
-
core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Convert.php, line 16
Namespace
Drupal\system\Plugin\ImageToolkit\Operation\gdView source
class Convert extends GDImageToolkitOperationBase {
/**
* {@inheritdoc}
*/
protected function arguments() {
return [
'extension' => [
'description' => 'The new extension of the converted image',
],
];
}
/**
* {@inheritdoc}
*/
protected function validateArguments(array $arguments) {
if (!in_array($arguments['extension'], $this->getToolkit()
->getSupportedExtensions())) {
throw new \InvalidArgumentException("Invalid extension ({$arguments['extension']}) specified for the image 'convert' operation");
}
return $arguments;
}
/**
* {@inheritdoc}
*/
protected function execute(array $arguments) {
// Create a new resource of the required dimensions and format, and copy
// the original resource on it with resampling. Destroy the original
// resource upon success.
$width = $this->getToolkit()
->getWidth();
$height = $this->getToolkit()
->getHeight();
$original_resource = $this->getToolkit()
->getResource();
$original_type = $this->getToolkit()
->getType();
$data = [
'width' => $width,
'height' => $height,
'extension' => $arguments['extension'],
'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, $width, $height, $width, $height)) {
imagedestroy($original_resource);
return TRUE;
}
// In case of error, reset resource and type to as it was.
$this->getToolkit()
->setResource($original_resource);
$this->getToolkit()
->setType($original_type);
}
return FALSE;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Convert::arguments | protected | function | Returns the definition of the operation arguments. | Overrides ImageToolkitOperationBase::arguments | |
Convert::execute | protected | function | Performs the actual manipulation on the image. | Overrides ImageToolkitOperationBase::execute | |
Convert::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.