class ConvolutionImageEffect in Image Effects 8

Filter image using convolution.

Plugin annotation

@ImageEffect(
  id = "image_effects_convolution",
  label = @Translation("Convolution"),
  description = @Translation("Filter image using convolution.")
)

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\ConvolutionImageEffect implements ContainerFactoryPluginInterface

File

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

Namespace

Drupal\image_effects\Plugin\ImageEffect

class ConvolutionImageEffect extends ConfigurableImageEffectBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'kernel' => [
        [
          0,
          0,
          0,
        ],
        [
          0,
          0,
          0,
        ],
        [
          0,
          0,
          0,
        ],
      ],
      'divisor' => 0,
      'offset' => 0,
      'label' => '',
    ] + parent::defaultConfiguration();
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['#attached']['library'][] = 'image_effects/image_effects.admin.convolution';
    $form['kernel'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Kernel matrix'),
      '#description' => $this
        ->t('Entries sum: <span class="kernel-matrix-sum">0</span>.'),
      '#required' => TRUE,
    ];
    $form['kernel']['entries'] = [];
    for ($i = 0; $i < 3; $i++) {
      $form['kernel']['entries'][$i] = [
        '#type' => 'container',
      ];
      for ($j = 0; $j < 3; $j++) {
        $form['kernel']['entries'][$i][$j] = [
          '#type' => 'number',
          '#title' => $this
            ->t("Matrix entry (@i,@j)", [
            '@i' => $i,
            '@j' => $j,
          ]),
          '#title_display' => 'invisible',
          '#default_value' => $this->configuration['kernel'][$i][$j],
          '#required' => TRUE,
          '#wrapper_attributes' => [
            'class' => [
              'kernel-entry',
            ],
          ],
        ];
      }
    }
    $form['divisor'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Divisor'),
      '#description' => $this
        ->t('Typically the matrix entries sum (normalization).'),
      '#default_value' => $this->configuration['divisor'],
      '#required' => TRUE,
      '#size' => 3,
    ];
    $form['offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Offset'),
      '#description' => $this
        ->t('This value is added to the division result.'),
      '#default_value' => $this->configuration['offset'],
      '#required' => TRUE,
      '#size' => 3,
    ];
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#description' => $this
        ->t('A label to identify this filter effect.'),
      '#default_value' => $this->configuration['label'],
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['kernel'] = $form_state
      ->getValue('kernel')['entries'];
    $this->configuration['divisor'] = $form_state
      ->getValue('divisor');
    $this->configuration['offset'] = $form_state
      ->getValue('offset');
    $this->configuration['label'] = $form_state
      ->getValue('label');
  }

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    return $image
      ->apply('convolution', [
      'kernel' => $this->configuration['kernel'],
      'divisor' => $this->configuration['divisor'],
      'offset' => $this->configuration['offset'],
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableImageEffectBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
ConvolutionImageEffect::applyEffect	public	function	Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
ConvolutionImageEffect::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ConvolutionImageEffect::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
ConvolutionImageEffect::getSummary	public	function	Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
ConvolutionImageEffect::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::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.