class CompositeImageEffect in Imagick 8

Composite one image onto another.

Plugin annotation


@ImageEffect(
  id = "image_composite",
  label = @Translation("Composite"),
  description = @Translation("Composite one image onto another at the specified offset.")
)

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\CompositeImageEffect

Expanded class hierarchy of CompositeImageEffect

File

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

Namespace

Drupal\imagick\Plugin\ImageEffect

View source

class CompositeImageEffect extends ConfigurableImageEffectBase {

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

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $path = $this->configuration['path'];
    $summary = [
      '#markup' => '- ' . (file_exists($path) ? $path : t('Invalid file path')),
      '#effect' => [
        'id' => $this->pluginDefinition['id'],
        'label' => $this
          ->label(),
        'description' => $this->pluginDefinition['description'],
      ],
    ];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'path' => '',
      'composite' => Imagick::COMPOSITE_DEFAULT,
      'x' => '0',
      'y' => '0',
      'channel' => [
        Imagick::CHANNEL_DEFAULT,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path'),
      '#description' => $this
        ->t('Path to the composite image. In- or external URL\'s are possible'),
      '#default_value' => $this->configuration['path'],
      '#element_validate' => [
        [
          $this,
          'elementValidateFilePath',
        ],
      ],
    ];
    $form['composite'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Composite'),
      '#options' => ImagickConst::composites(),
      '#description' => $this
        ->t('Composite operator'),
      '#default_value' => $this->configuration['composite'],
    ];
    $form['x'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('X-offset'),
      '#description' => $this
        ->t('The column offset of the composited image'),
      '#default_value' => $this->configuration['x'],
    ];
    $form['y'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Y-offset'),
      '#description' => $this
        ->t('The row offset of the composited image'),
      '#default_value' => $this->configuration['y'],
    ];
    $form['channel'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Channel'),
      '#options' => ImagickConst::channels(),
      '#multiple' => TRUE,
      '#size' => 10,
      '#description' => $this
        ->t('Provide any channel constant that is valid for your channel mode. It is possible to apply more than one channel'),
      '#default_value' => $this->configuration['channel'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['path'] = $form_state
      ->getValue('path');
    $this->configuration['composite'] = $form_state
      ->getValue('composite');
    $this->configuration['x'] = $form_state
      ->getValue('x');
    $this->configuration['y'] = $form_state
      ->getValue('y');
    $this->configuration['channel'] = $form_state
      ->getValue('channel');
  }

  /**
   * @param $element
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public static function elementValidateFilePath($element, FormStateInterface &$form_state) {
    if (!file_exists($element['#value'])) {
      $form_state
        ->setError($element, t('File does not exist.'));
    }
  }

}

Members

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

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation