class Convert

Same name in other branches
  1. 9 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
  2. 8.9.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
  3. 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert

Defines GD2 convert operation.

Attributes

#[ImageToolkitOperation(id: "gd_convert", toolkit: "gd", operation: "convert", label: new TranslatableMarkup("Convert"), description: new TranslatableMarkup("Instructs the toolkit to save the image with a specified extension."))]

Hierarchy

Expanded class hierarchy of Convert

5 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().
ToolkitTestTrait::assertToolkitOperationsCalled in core/tests/Drupal/Tests/Traits/Core/Image/ToolkitTestTrait.php
Assert that all of the specified image toolkit operations were called once.

File

core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php, line 11

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd
View 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 image of the required dimensions and format, and copy
        // the original image on it with resampling. Restore the original image upon
        // failure.
        $width = $this->getToolkit()
            ->getWidth();
        $height = $this->getToolkit()
            ->getHeight();
        $original_image = $this->getToolkit()
            ->getImage();
        $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()
                ->getImage(), $original_image, 0, 0, 0, 0, $width, $height, $width, $height)) {
                return TRUE;
            }
            // In case of error, reset image and type to as it was.
            $this->getToolkit()
                ->setImage($original_image);
            $this->getToolkit()
                ->setType($original_type);
        }
        return FALSE;
    }

}

Members

Title 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.