class Convert

Same name and namespace in other branches
  1. 11.x core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
  2. 10 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert
  3. 9 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

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/Functional/ImageEffectsTest.php
Tests the ConvertImageEffect plugin.
ImageTest::testConvert in core/tests/Drupal/Tests/Core/Image/ImageTest.php
Tests \Drupal\Core\Image\Image::convert().
ToolkitGdTest::testManipulations in core/tests/Drupal/KernelTests/Core/Image/ToolkitGdTest.php
Since PHP can't visually check that our images have been manipulated properly, build a list of expected color values for each of the corners and the expected height and widths for the final images.
ToolkitTestBase::assertToolkitOperationsCalled in core/modules/system/src/Tests/Image/ToolkitTestBase.php
Assert that all of the specified image toolkit operations were called exactly once once, other values result in failure.

... See full list

File

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

Namespace

Drupal\system\Plugin\ImageToolkit\Operation\gd
View on git.drupalcode.org
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 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;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.