class 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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface extends \Drupal\Core\Plugin\PluginBase
- 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 implements \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
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\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 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 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 | |
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| 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. | Overrides PluginBase::__construct | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| PluginBase::$pluginId | protected | property | The plugin ID. | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | 
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.