class DefineCanvasImageEffect in Imagick 8

Applies the define canvas effect on an image resource.

Plugin annotation


@ImageEffect(
  id = "image_define_canvas",
  label = @Translation("Define canvas"),
  description = @Translation("Applies the define canvas effect on an 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\imagick\Plugin\ImageEffect\DefineCanvasImageEffect

Expanded class hierarchy of DefineCanvasImageEffect

File

src/Plugin/ImageEffect/DefineCanvasImageEffect.php, line 18

Namespace

Drupal\imagick\Plugin\ImageEffect

View source

class DefineCanvasImageEffect extends ConfigurableImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image
      ->apply('define_canvas', $this->configuration)) {
      $this->logger
        ->error('Image define canvas failed using the %toolkit toolkit on %path (%mimetype)', [
        '%toolkit' => $image
          ->getToolkitId(),
        '%path' => $image
          ->getSource(),
        '%mimetype' => $image
          ->getMimeType(),
      ]);
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'HEX' => '#FFFFFF',
      'under' => TRUE,
      'exact_measurements' => TRUE,
      'exact' => [
        'width' => '100',
        'height' => '100',
        'anchor' => 'center-center',
      ],
      'relative' => [
        'leftdiff' => '20',
        'rightdiff' => '20',
        'topdiff' => '20',
        'bottomdiff' => '20',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'colorform',
        ],
      ],
    ];
    $form['HEX'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('HEX'),
      '#default_value' => $this->configuration['HEX'],
      '#attributes' => [
        'class' => [
          'colorentry',
        ],
      ],
    ];
    $form['colorpicker'] = [
      '#weight' => -1,
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'colorpicker',
        ],
        'style' => [
          'float:right',
        ],
      ],
    ];

    // Add Farbtastic color picker.
    $form['matte_color']['#attached'] = [
      'library' => [
        'imagick/colorpicker',
      ],
    ];
    $form['under'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Resize canvas <em>under</em> image (possibly cropping)'),
      '#default_value' => $this->configuration['under'],
      '#description' => $this
        ->t('If <em>not</em> set, this will create a solid flat layer, probably totally obscuring the source image'),
    ];
    $form['info'] = [
      '#value' => $this
        ->t('Enter values in ONLY ONE of the below options. Either exact or relative. Most values are optional - you can adjust only one dimension as needed. If no useful values are set, the current base image size will be used.'),
    ];
    $form['exact_measurements'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exact measurements'),
      '#default_value' => $this->configuration['exact_measurements'],
    ];
    $form['exact'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Exact size'),
      'help' => [
        '#markup' => $this
          ->t('Set the canvas to a precise size, possibly cropping the image. Use to start with a known size.'),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ],
      'width' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Width'),
        '#default_value' => $this->configuration['exact']['width'],
        '#description' => $this
          ->t('Enter a value in pixels or percent'),
        '#size' => 5,
      ],
      'height' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Height'),
        '#default_value' => $this->configuration['exact']['height'],
        '#description' => $this
          ->t('Enter a value in pixels or percent'),
        '#size' => 5,
      ],
      'anchor' => [
        '#type' => 'radios',
        '#title' => $this
          ->t('Anchor'),
        '#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']['anchor'],
      ],
      '#states' => [
        'visible' => [
          ':input[name="data[exact_measurements]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['relative'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Relative size'),
      'help' => [
        '#markup' => $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.'),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ],
      'leftdiff' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('left difference'),
        '#default_value' => $this->configuration['relative']['leftdiff'],
        '#size' => 6,
        '#description' => $this
          ->t('Enter an offset in pixels.'),
      ],
      'rightdiff' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('right difference'),
        '#default_value' => $this->configuration['relative']['rightdiff'],
        '#size' => 6,
        '#description' => $this
          ->t('Enter an offset in pixels.'),
      ],
      'topdiff' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('top difference'),
        '#default_value' => $this->configuration['relative']['topdiff'],
        '#size' => 6,
        '#description' => $this
          ->t('Enter an offset in pixels.'),
      ],
      'bottomdiff' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('bottom difference'),
        '#default_value' => $this->configuration['relative']['bottomdiff'],
        '#size' => 6,
        '#description' => $this
          ->t('Enter an offset in pixels.'),
      ],
      '#states' => [
        'visible' => [
          ':input[name="data[exact_measurements]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['HEX'] = $form_state
      ->getValue('HEX');
    $this->configuration['under'] = $form_state
      ->getValue('under');
    $this->configuration['exact_measurements'] = $form_state
      ->getValue('exact_measurements');
    $this->configuration['exact']['width'] = $form_state
      ->getValue([
      'exact',
      'width',
    ]);
    $this->configuration['exact']['height'] = $form_state
      ->getValue([
      'exact',
      'height',
    ]);
    $this->configuration['exact']['anchor'] = $form_state
      ->getValue([
      'exact',
      'anchor',
    ]);
    $this->configuration['relative']['leftdiff'] = $form_state
      ->getValue([
      'relative',
      'leftdiff',
    ]);
    $this->configuration['relative']['rightdiff'] = $form_state
      ->getValue([
      'relative',
      'rightdiff',
    ]);
    $this->configuration['relative']['topdiff'] = $form_state
      ->getValue([
      'relative',
      'topdiff',
    ]);
    $this->configuration['relative']['bottomdiff'] = $form_state
      ->getValue([
      'relative',
      'bottomdiff',
    ]);
  }

}

Members

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

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation