class SetCanvasImageEffect in Image Effects 8.3

Same name and namespace in other branches

8 src/Plugin/ImageEffect/SetCanvasImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\SetCanvasImageEffect
8.2 src/Plugin/ImageEffect/SetCanvasImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\SetCanvasImageEffect

Class SetCanvasImageEffect.

Plugin annotation


@ImageEffect(
  id = "image_effects_set_canvas",
  label = @Translation("Set canvas"),
  description = @Translation("Define the size of the working canvas and background color, this controls the dimensions of the output image.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
    class \Drupal\image\ConfigurableImageEffectBase implements ConfigurableImageEffectInterface
    class \Drupal\image_effects\Plugin\ImageEffect\SetCanvasImageEffect

Expanded class hierarchy of SetCanvasImageEffect

File

src/Plugin/ImageEffect/SetCanvasImageEffect.php, line 20

Namespace

Drupal\image_effects\Plugin\ImageEffect

View source

class SetCanvasImageEffect extends ConfigurableImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return NestedArray::mergeDeep([
      'canvas_size' => 'exact',
      'canvas_color' => NULL,
      'exact' => [
        'width' => '',
        'height' => '',
        'placement' => 'center-center',
        'x_offset' => 0,
        'y_offset' => 0,
      ],
      'relative' => [
        'left' => 0,
        'right' => 0,
        'top' => 0,
        'bottom' => 0,
      ],
    ], parent::defaultConfiguration());
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $data = $this->configuration;
    $data['color_info'] = [
      '#theme' => 'image_effects_color_detail',
      '#color' => $this->configuration['canvas_color'],
      '#border' => TRUE,
      '#border_color' => 'matchLuma',
    ];
    return [
      '#theme' => 'image_effects_set_canvas_summary',
      '#data' => $data,
    ] + parent::getSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['canvas_size'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Canvas size'),
      '#default_value' => $this->configuration['canvas_size'],
      '#options' => [
        'exact' => $this
          ->t('Exact size'),
        'relative' => $this
          ->t('Relative size'),
      ],
      '#required' => TRUE,
    ];

    // Exact size canvas.
    $form['exact'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Exact size'),
      '#description' => $this
        ->t('Set the canvas to a precise size, possibly cropping the image. Use to start with a known size.'),
      '#open' => TRUE,
      '#collapsible' => FALSE,
      '#states' => [
        'visible' => [
          ':input[name="data[canvas_size]"]' => [
            'value' => 'exact',
          ],
        ],
      ],
    ];
    $form['exact']['width'] = [
      '#type' => 'image_effects_px_perc',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this->configuration['exact']['width'],
      '#description' => $this
        ->t('Enter a value, and specify if pixels or percent. Leave blank to keep source image width.'),
      '#size' => 6,
      '#maxlength' => 6,
    ];
    $form['exact']['height'] = [
      '#type' => 'image_effects_px_perc',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this->configuration['exact']['height'],
      '#description' => $this
        ->t('Enter a value, and specify if pixels or percent. Leave blank to keep source image height.'),
      '#size' => 6,
      '#maxlength' => 6,
    ];
    $form['exact']['placement'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Placement'),
      '#options' => [
        'left-top' => $this
          ->t('Top left'),
        'center-top' => $this
          ->t('Top center'),
        'right-top' => $this
          ->t('Top right'),
        'left-center' => $this
          ->t('Center left'),
        'center-center' => $this
          ->t('Center'),
        'right-center' => $this
          ->t('Center right'),
        'left-bottom' => $this
          ->t('Bottom left'),
        'center-bottom' => $this
          ->t('Bottom center'),
        'right-bottom' => $this
          ->t('Bottom right'),
      ],
      '#theme' => 'image_anchor',
      '#default_value' => $this->configuration['exact']['placement'],
      '#description' => $this
        ->t('Position of the image on the canvas.'),
    ];
    $form['exact']['x_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Horizontal offset'),
      '#field_suffix' => 'px',
      '#description' => $this
        ->t('Additional horizontal offset from placement.'),
      '#default_value' => $this->configuration['exact']['x_offset'],
      '#maxlength' => 4,
      '#size' => 4,
    ];
    $form['exact']['y_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Vertical offset'),
      '#field_suffix' => 'px',
      '#description' => $this
        ->t('Additional vertical offset from placement.'),
      '#default_value' => $this->configuration['exact']['y_offset'],
      '#maxlength' => 4,
      '#size' => 4,
    ];

    // Relative size canvas.
    $form['relative'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Relative size'),
      '#description' => $this
        ->t('Set the canvas to a relative size, based on the current image dimensions. Use to add simple borders or expand by a fixed amount. Negative values may crop the image.'),
      '#open' => TRUE,
      '#collapsible' => FALSE,
      '#states' => [
        'visible' => [
          ':input[name="data[canvas_size]"]' => [
            'value' => 'relative',
          ],
        ],
      ],
    ];
    $form['relative']['left'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Left margin'),
      '#default_value' => $this->configuration['relative']['left'],
      '#maxlength' => 4,
      '#size' => 4,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ];
    $form['relative']['right'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Right margin'),
      '#default_value' => $this->configuration['relative']['right'],
      '#maxlength' => 4,
      '#size' => 4,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ];
    $form['relative']['top'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Top margin'),
      '#default_value' => $this->configuration['relative']['top'],
      '#maxlength' => 4,
      '#size' => 4,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ];
    $form['relative']['bottom'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Bottom margin'),
      '#default_value' => $this->configuration['relative']['bottom'],
      '#maxlength' => 4,
      '#size' => 4,
      '#description' => $this
        ->t('Enter an offset in pixels.'),
    ];

    // Canvas color.
    $form['canvas_color'] = [
      '#type' => 'image_effects_color',
      '#title' => $this
        ->t('Canvas color'),
      '#allow_null' => TRUE,
      '#allow_opacity' => TRUE,
      '#description' => $this
        ->t("This will have the effect of adding colored (or transparent) margins around the image."),
      '#default_value' => $this->configuration['canvas_color'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $this->configuration = $form_state
      ->getValues();
  }

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $data = [];
    $data['canvas_color'] = $this->configuration['canvas_color'];

    // Get resulting dimensions.
    $dimensions = $this
      ->getDimensions($image
      ->getWidth(), $image
      ->getHeight());
    $data['width'] = $dimensions['width'];
    $data['height'] = $dimensions['height'];

    // Get offset of original image.
    if ($this->configuration['canvas_size'] === 'exact') {
      list($x_pos, $y_pos) = explode('-', $this->configuration['exact']['placement']);
      $data['x_pos'] = image_filter_keyword($x_pos, $data['width'], $image
        ->getWidth()) + $this->configuration['exact']['x_offset'];
      $data['y_pos'] = image_filter_keyword($y_pos, $data['height'], $image
        ->getHeight()) + $this->configuration['exact']['y_offset'];
    }
    else {
      $data['x_pos'] = $this->configuration['relative']['left'];
      $data['y_pos'] = $this->configuration['relative']['top'];
    }

    // All the math is done, now defer to the toolkit in use.
    return $image
      ->apply('set_canvas', $data);
  }

  /**
   * {@inheritdoc}
   */
  public function transformDimensions(array &$dimensions, $uri) {
    if ($dimensions['width'] && $dimensions['height']) {
      $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 = [];
    if ($this->configuration['canvas_size'] === 'exact') {

      // Exact size.
      $tmp_width = $this->configuration['exact']['width'] ?: $source_width;
      $tmp_height = $this->configuration['exact']['height'] ?: $source_height;
      $dimensions['width'] = ImageUtility::percentFilter($tmp_width, $source_width);
      $dimensions['height'] = ImageUtility::percentFilter($tmp_height, $source_height);
    }
    else {

      // Relative size.
      $dimensions['width'] = $source_width + $this->configuration['relative']['left'] + $this->configuration['relative']['right'];
      $dimensions['height'] = $source_height + $this->configuration['relative']['top'] + $this->configuration['relative']['bottom'];
    }
    return $dimensions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableImageEffectBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	4
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
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.
SetCanvasImageEffect::applyEffect	public	function	Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
SetCanvasImageEffect::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
SetCanvasImageEffect::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
SetCanvasImageEffect::getDimensions	protected	function	Calculate resulting image dimensions.
SetCanvasImageEffect::getSummary	public	function	Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
SetCanvasImageEffect::transformDimensions	public	function	Determines the dimensions of the styled image. Overrides ImageEffectBase::transformDimensions
SetCanvasImageEffect::validateConfigurationForm	public	function	Form validation handler. Overrides ConfigurableImageEffectBase::validateConfigurationForm
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.

You are here

class SetCanvasImageEffect in Image Effects 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation