You are here

Home » API reference » Image effect kit 8 » ImageFilterEffect.php

class ImageFilterEffect in Image effect kit 8

IEK - Filter.

Plugin annotation


@ImageEffect(
  id = "iek_image_filter",
  label = @Translation("IEK - Filter"),
  description = @Translation("Apply a filter to an image.")
)

Hierarchy

Expanded class hierarchy of ImageFilterEffect

File

src/Plugin/ImageEffect/ImageFilterEffect.php, line 23
Contains \Drupal\iek\Plugin\ImageEffect\ImageFilterEffect.

Namespace

Drupal\iek\Plugin\ImageEffect
View source 
class ImageFilterEffect extends ConfigurableImageEffectBase {

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

  /**
   * {@inheritdoc}
   */
  public function transformDimensions(array &$dimensions, $uri) {
    $dimensions['filter_name'] = $this->configuration['filter_name'];
    $dimensions['repeat'] = $this->configuration['repeat'];
    $dimensions['arg1'] = $this->configuration['arg1'];
    $dimensions['arg2'] = $this->configuration['arg2'];
    $dimensions['arg3'] = $this->configuration['arg3'];
    $dimensions['arg4'] = $this->configuration['arg4'];
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'filter_name' => '',
      'repeat' => 1,
      'arg1' => 0,
      'arg2' => 0,
      'arg3' => 0,
      'arg4' => 0,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $filters = iek_get_image_filters();
    $int127 = [];
    $int255 = [];
    for ($i = 0; $i <= 255; $i++) {
      if ($i <= 127) {
        $int127[$i] = $i;
      }
      $int255[$i] = $i;
    }
    $form['filter_name'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Filter name'),
      '#default_value' => $this->configuration['filter_name'],
      '#options' => $filters,
      '#required' => TRUE,
    ];
    $form['repeat'] = [
      '#type' => 'select',
      '#options' => $int255,
      '#title' => $this
        ->t('Repeat'),
      '#description' => $this
        ->t('How many times do you want to repeat the filter action? Caution: higher repeat times will cause your site performance issue.'),
      '#default_value' => $this->configuration['repeat'],
      '#required' => TRUE,
    ];
    $form['arg1'] = [
      '#type' => 'select',
      '#options' => $int255,
      '#title' => $this
        ->t('arg1'),
      '#default_value' => $this->configuration['arg1'],
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="data[filter_name]"]' => [
            [
              'value' => IMG_FILTER_BRIGHTNESS,
            ],
            [
              'value' => IMG_FILTER_CONTRAST,
            ],
            [
              'value' => IMG_FILTER_COLORIZE,
            ],
            [
              'value' => IMG_FILTER_SMOOTH,
            ],
            [
              'value' => IMG_FILTER_PIXELATE,
            ],
          ],
        ],
      ],
    ];
    $form['arg2'] = [
      '#type' => 'select',
      '#options' => $int255,
      '#title' => $this
        ->t('arg2'),
      '#default_value' => $this->configuration['arg2'],
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="data[filter_name]"]' => [
            [
              'value' => IMG_FILTER_COLORIZE,
            ],
            [
              'value' => IMG_FILTER_PIXELATE,
            ],
          ],
        ],
      ],
    ];
    $form['arg3'] = [
      '#type' => 'select',
      '#options' => $int255,
      '#title' => $this
        ->t('arg3'),
      '#default_value' => $this->configuration['arg3'],
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="data[filter_name]"]' => [
            [
              'value' => IMG_FILTER_COLORIZE,
            ],
          ],
        ],
      ],
    ];
    $form['arg4'] = [
      '#type' => 'select',
      '#options' => $int127,
      '#title' => $this
        ->t('arg4'),
      '#default_value' => $this->configuration['arg4'],
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="data[filter_name]"]' => [
            [
              'value' => IMG_FILTER_COLORIZE,
            ],
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['filter_name'] = $form_state
      ->getValue('filter_name');
    $this->configuration['repeat'] = $form_state
      ->getValue('repeat');
    $this->configuration['arg1'] = $form_state
      ->getValue('arg1');
    $this->configuration['arg2'] = $form_state
      ->getValue('arg2');
    $this->configuration['arg3'] = $form_state
      ->getValue('arg3');
    $this->configuration['arg4'] = $form_state
      ->getValue('arg4');
  }

}

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