You are here

class BlurImageEffect in Imagick 8

Blurs an image resource.

Plugin annotation


@ImageEffect(
  id = "image_blur",
  label = @Translation("Blur"),
  description = @Translation("Blurs an image, different methods can be used.")
)

Hierarchy

Expanded class hierarchy of BlurImageEffect

File

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

Namespace

Drupal\imagick\Plugin\ImageEffect
View source
class BlurImageEffect extends ConfigurableImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image
      ->apply('blur', $this->configuration)) {
      $this->logger
        ->error('Image blur 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 [
      'type' => ImagickConst::NORMAL_BLUR,
      'radius' => '16',
      'sigma' => '16',
      'angle' => '0',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['help'] = [
      '#value' => $this
        ->t('The intensity of the blur effect. For reasonable results, the radius should be larger than sigma.'),
    ];
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Blur type'),
      '#options' => [
        ImagickConst::NORMAL_BLUR => $this
          ->t('Normal'),
        ImagickConst::ADAPTIVE_BLUR => $this
          ->t('Adaptive'),
        ImagickConst::GAUSSIAN_BLUR => $this
          ->t('Gaussian'),
        ImagickConst::MOTION_BLUR => $this
          ->t('Motion'),
        ImagickConst::RADIAL_BLUR => $this
          ->t('Radial'),
      ],
      '#default_value' => $this->configuration['type'],
    ];
    $form['radius'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Radius'),
      '#description' => $this
        ->t('The radius of the Gaussian, in pixels, not counting the center pixel.'),
      '#states' => [
        'invisible' => [
          ':input[name="data[type]"]' => [
            'value' => ImagickConst::RADIAL_BLUR,
          ],
        ],
      ],
      '#default_value' => $this->configuration['radius'],
    ];
    $form['sigma'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Sigma'),
      '#description' => $this
        ->t('The standard deviation of the Gaussian, in pixels'),
      '#states' => [
        'invisible' => [
          ':input[name="data[type]"]' => [
            'value' => ImagickConst::RADIAL_BLUR,
          ],
        ],
      ],
      '#default_value' => $this->configuration['sigma'],
    ];
    $form['angle'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Angle'),
      '#description' => $this
        ->t('The angle of the blur'),
      '#states' => [
        'visible' => [
          ':input[name="data[type]"]' => [
            [
              'value' => ImagickConst::MOTION_BLUR,
            ],
            [
              'value' => ImagickConst::RADIAL_BLUR,
            ],
          ],
        ],
      ],
      '#default_value' => $this->configuration['angle'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['type'] = $form_state
      ->getValue('type');
    $this->configuration['radius'] = $form_state
      ->getValue('radius');
    $this->configuration['sigma'] = $form_state
      ->getValue('sigma');
    $this->configuration['angle'] = $form_state
      ->getValue('angle');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlurImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
BlurImageEffect::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
BlurImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
BlurImageEffect::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::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.