You are here

Home » API reference » Image Effects 8 » ImagemagickArgumentsImageEffect.php

class ImagemagickArgumentsImageEffect in Image Effects 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/ImageEffect/ImagemagickArgumentsImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\ImagemagickArgumentsImageEffect
  2. 8.2 src/Plugin/ImageEffect/ImagemagickArgumentsImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\ImagemagickArgumentsImageEffect

Class ImagemagickArgumentsImageEffect.

Plugin annotation


@ImageEffect(
  id = "image_effects_imagemagick_arguments",
  label = @Translation("ImageMagick arguments"),
  description = @Translation("Directly enter ImageMagick/GraphicsMagick command line arguments.")
)

Hierarchy

Expanded class hierarchy of ImagemagickArgumentsImageEffect

File

src/Plugin/ImageEffect/ImagemagickArgumentsImageEffect.php, line 19

Namespace

Drupal\image_effects\Plugin\ImageEffect
View source 
class ImagemagickArgumentsImageEffect extends ConfigurableImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'command_line' => '',
      'dimensions_method' => 'keep',
      'width' => '',
      'height' => '',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return [
      '#theme' => 'image_effects_imagemagick_arguments_summary',
      '#data' => $this->configuration,
    ] + parent::getSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['command_line'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Command line arguments'),
      '#default_value' => $this->configuration['command_line'],
      '#description' => $this
        ->t('<strong>Enter the command line <em>arguments</em> only.</strong><br/>Remember to escape parenthesis (and remember escaping is platform specific, use \\ on *nix and ^ on Windows).<br />Do not add an input or output file. Drupal ImageAPI will add "convert" before and a "-quality" option after based on the toolkit configuration settings.'),
      '#rows' => '5',
      '#resizable' => 'TRUE',
      '#required' => 'TRUE',
    ];
    $form['dimensions_method'] = [
      '#type' => 'radios',
      '#title' => t('Dimensions'),
      '#description' => $this
        ->t("Dimensions are stored in the Drupal image object and used for output HTML image (img) element <em>width</em> and <em>height</em> attributes. <em>They have no effect on the real size of the image, but may affect the display.</em><br />It's not possible to detect the dimensions of the Imagemagick command's result image in the scope of this effect, so you have to decide what dimensions to pass to ImageAPI here."),
      '#default_value' => $this->configuration['dimensions_method'],
      '#options' => [
        'keep' => $this
          ->t("<strong>Keep dimensions.</strong> Pass through the current image dimensions. Use if the arguments specified above do not change image size."),
        'value' => $this
          ->t('<strong>Manual input.</strong> If you know the size of the image that the arguments specified above will produce, specify them below, either in pixels or as % of the current image dimensions.'),
        'strip' => $this
          ->t("<strong>Strip dimensions.</strong> This won't pass on any image dimensions. Images will have no HTML <em>width</em> and <em>height</em> attributes if this effect is the last in the image style. Use this if you have another dimension altering effect after this."),
      ],
      '#required' => TRUE,
    ];
    $form['dimensions'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Width and Height'),
      '#description' => $this
        ->t('Indicate width and height.'),
      '#open' => TRUE,
      '#collapsible' => FALSE,
      '#states' => [
        'visible' => [
          ':input[name="data[dimensions_method]"]' => [
            'value' => 'value',
          ],
        ],
      ],
    ];
    $form['dimensions']['width'] = [
      '#type' => 'image_effects_px_perc',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this->configuration['width'],
      '#required' => FALSE,
      '#size' => 5,
    ];
    $form['dimensions']['height'] = [
      '#type' => 'image_effects_px_perc',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this->configuration['height'],
      '#required' => FALSE,
      '#size' => 5,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['command_line'] = $form_state
      ->getValue('command_line');
    $this->configuration['dimensions_method'] = $form_state
      ->getValue('dimensions_method');
    $this->configuration['width'] = $form_state
      ->getValue([
      'dimensions',
      'width',
    ]);
    $this->configuration['height'] = $form_state
      ->getValue([
      'dimensions',
      'height',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {

    // Get resulting dimensions.
    $d = $this
      ->getDimensions($image
      ->getWidth(), $image
      ->getHeight());
    return $image
      ->apply('imagemagick_arguments', [
      'command_line' => str_replace([
        "\r",
        "\n",
      ], ' ', $this->configuration['command_line']),
      'width' => $d['width'],
      'height' => $d['height'],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function transformDimensions(array &$dimensions, $uri) {
    $d = $this
      ->getDimensions($dimensions['width'], $dimensions['height']);
    $dimensions['width'] = $d['width'];
    $dimensions['height'] = $d['height'];
  }

  /**
   * Calculate resulting image dimensions.
   *
   * @param int $source_width
   *   Source image width.
   * @param int $source_height
   *   Source image height.
   *
   * @return array
   *   Associative array.
   *   - width: Integer with the derivative image width.
   *   - height: Integer with the derivative image height.
   */
  protected function getDimensions($source_width, $source_height) {
    $dimensions = [];
    switch ($this->configuration['dimensions_method']) {
      case 'strip':

        // Strip dimensions of the result.
        $dimensions['width'] = $dimensions['height'] = NULL;
        break;
      case 'keep':

        // Keep original image dimensions.
        $dimensions['width'] = $source_width;
        $dimensions['height'] = $source_height;
        break;
      case 'value':

        // Manually specified dimensions.
        $dimensions['width'] = ImageUtility::percentFilter($this->configuration['width'], $source_width);
        $dimensions['height'] = ImageUtility::percentFilter($this->configuration['height'], $source_height);
        break;
    }
    return $dimensions;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableImageEffectBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
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
ImageEffectBase::$logger protected property A logger instance.
ImageEffectBase::$uuid protected property The image effect ID.
ImageEffectBase::$weight protected property The weight of the image effect.
ImageEffectBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension public function Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension 1
ImageEffectBase::getUuid public function Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight public function Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
ImagemagickArgumentsImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
ImagemagickArgumentsImageEffect::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ImagemagickArgumentsImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
ImagemagickArgumentsImageEffect::getDimensions protected function Calculate resulting image dimensions.
ImagemagickArgumentsImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
ImagemagickArgumentsImageEffect::submitConfigurationForm public function Form submission handler. Overrides ConfigurableImageEffectBase::submitConfigurationForm
ImagemagickArgumentsImageEffect::transformDimensions public function Determines the dimensions of the styled image. Overrides ImageEffectBase::transformDimensions
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.