You are here

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

class ImageOverlayEffect in Image effect kit 8

IEK - Overlay.

Plugin annotation


@ImageEffect(
  id = "iek_image_overlay",
  label = @Translation("IEK - Overlay"),
  description = @Translation("Apply an overlay to an image.")
)

Hierarchy

Expanded class hierarchy of ImageOverlayEffect

File

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

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image
      ->apply('iek_image_overlay', $this->configuration)) {
      $this->logger
        ->error('IEK - Overlay 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['overlay_name'] = $this->configuration['overlay_name'];
    $dimensions['overlay_offset'] = $this->configuration['overlay_offset'];
    $dimensions['bg_offset'] = $this->configuration['bg_offset'];
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $data = $this->configuration;
    $iek_overlays = iek_get_overlays();
    foreach ($iek_overlays as $item1) {
      foreach ($item1['children'] as $item2) {
        if ($item2['name'] == $data['overlay_name']) {
          $data['overlay_name'] = $item2['title'];
        }
      }
    }
    $summary = [
      '#theme' => 'iek_image_overlay_summary',
      '#data' => $data,
    ];
    $summary += parent::getSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'overlay_name' => '',
      'overlay_offset' => 0,
      'bg_offset' => 0,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $iek_overlays = iek_get_overlays();
    $overlay_names = [];
    foreach ($iek_overlays as $item1) {
      foreach ($item1['children'] as $item2) {
        $overlay_names[$item1['name']][$item2['name']] = $item2['title'];
      }
    }
    $form['overlay_name'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Overlay name'),
      '#default_value' => $this->configuration['overlay_name'],
      '#options' => $overlay_names,
      '#required' => TRUE,
    ];
    $form['overlay_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Overlay offset'),
      '#default_value' => $this->configuration['overlay_offset'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
    ];
    $form['bg_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Background offset'),
      '#default_value' => $this->configuration['bg_offset'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
    ];
    return $form;
  }

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

}

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