You are here

class Convert in ImageMagick 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/ImageToolkit/Operation/imagemagick/Convert.php \Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick\Convert
  2. 8.2 src/Plugin/ImageToolkit/Operation/imagemagick/Convert.php \Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick\Convert

Defines imagemagick Convert operation.

Plugin annotation


@ImageToolkitOperation(
  id = "imagemagick_convert",
  toolkit = "imagemagick",
  operation = "convert",
  label = @Translation("Convert"),
  description = @Translation("Instructs the toolkit to save the image with a specified format.")
)

Hierarchy

Expanded class hierarchy of Convert

File

src/Plugin/ImageToolkit/Operation/imagemagick/Convert.php, line 16

Namespace

Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick
View source
class Convert extends ImagemagickImageToolkitOperationBase {

  /**
   * {@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) {

    // When source image is multi-frame, convert only the first frame.
    if ($this
      ->getToolkit()
      ->getFrames()) {
      $path = $this
        ->getToolkit()
        ->getSourceLocalPath();
      if (strripos($path, '[0]', -3) === FALSE) {
        $this
          ->getToolkit()
          ->setSourceLocalPath($path . '[0]');
      }
    }
    $this
      ->getToolkit()
      ->setFrames(NULL)
      ->setDestinationFormatFromExtension($arguments['extension']);
    return TRUE;
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
ImagemagickImageToolkitOperationBase::getToolkit protected function The correctly typed image toolkit for imagemagick 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 if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::__construct public function Constructs an image toolkit operation plugin. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.