You are here

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

class ImageWatermarkEffect in Image effect kit 8

IEK - Watermark.

Plugin annotation


@ImageEffect(
  id = "iek_image_watermark",
  label = @Translation("IEK - Watermark"),
  description = @Translation("Add a watermark text on an image.")
)

Hierarchy

Expanded class hierarchy of ImageWatermarkEffect

File

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

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image
      ->apply('iek_image_watermark', $this->configuration)) {
      $this->logger
        ->error('IEK - Watermark 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['text'] = $this->configuration['text'];
    $dimensions['font'] = $this->configuration['font'];
    $dimensions['color'] = $this->configuration['color'];
    $dimensions['size'] = $this->configuration['size'];
    $dimensions['angle'] = $this->configuration['angle'];
    $dimensions['position'] = $this->configuration['position'];
    $dimensions['padding_top'] = $this->configuration['padding_top'];
    $dimensions['padding_right'] = $this->configuration['padding_right'];
    $dimensions['padding_bottom'] = $this->configuration['padding_bottom'];
    $dimensions['padding_left'] = $this->configuration['padding_left'];
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'text' => '',
      'font' => '',
      'color' => '#FFFFFF',
      'size' => 24,
      'angle' => -45,
      'position' => 'middle_center',
      'padding_top' => 10,
      'padding_right' => 10,
      'padding_bottom' => 10,
      'padding_left' => 10,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $iek_fonts = iek_get_watermark_fonts();
    $fonts = [];
    foreach ($iek_fonts as $item) {
      $fonts[$item['name']] = $item['title'];
    }
    $form['text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Text'),
      '#default_value' => $this->configuration['text'],
      '#description' => $this
        ->t('Enter the text string for this effect. You can also enter tokens, that will be resolved when applying the effect. <b>Note:</b> only global tokens can be resolved by standard Drupal Image field formatters and widgets.'),
      '#required' => TRUE,
    ];
    if ($token_tree_builder = $this
      ->getTokenTreeBuilder()) {
      $form['token_wrapper'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Tokens'),
        '#group' => 'settings',
      ];
      $form['token_wrapper']['tokens'] = $token_tree_builder
        ->buildRenderable([]);
    }
    $form['font'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Font'),
      '#default_value' => $this->configuration['font'],
      '#options' => $fonts,
      '#required' => TRUE,
    ];
    $form['color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Color'),
      '#default_value' => $this->configuration['color'],
      '#size' => 10,
      '#maxlength' => 7,
      '#required' => TRUE,
    ];
    $form['size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Size'),
      '#default_value' => $this->configuration['size'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
      '#min' => 1,
    ];
    $form['angle'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Angle'),
      '#default_value' => $this->configuration['angle'],
      '#field_suffix' => ' %',
      '#required' => TRUE,
    ];
    $form['position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Position'),
      '#default_value' => $this->configuration['position'],
      '#options' => $this
        ->getAlignPositions(),
    ];
    $form['padding_top'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Padding top'),
      '#default_value' => $this->configuration['padding_top'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
      '#min' => 1,
    ];
    $form['padding_right'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Padding right'),
      '#default_value' => $this->configuration['padding_right'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
      '#min' => 1,
    ];
    $form['padding_bottom'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Padding bottom'),
      '#default_value' => $this->configuration['padding_bottom'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
      '#min' => 1,
    ];
    $form['padding_left'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Padding left'),
      '#default_value' => $this->configuration['padding_left'],
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#required' => TRUE,
      '#min' => 1,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['text'] = $form_state
      ->getValue('text');
    $this->configuration['font'] = $form_state
      ->getValue('font');
    $this->configuration['color'] = $form_state
      ->getValue('color');
    $this->configuration['size'] = $form_state
      ->getValue('size');
    $this->configuration['angle'] = $form_state
      ->getValue('angle');
    $this->configuration['position'] = $form_state
      ->getValue('position');
    $this->configuration['padding_top'] = $form_state
      ->getValue('padding_top');
    $this->configuration['padding_right'] = $form_state
      ->getValue('padding_right');
    $this->configuration['padding_bottom'] = $form_state
      ->getValue('padding_bottom');
    $this->configuration['padding_left'] = $form_state
      ->getValue('padding_left');
  }
  private function getAlignPositions() {
    return [
      'top_left' => $this
        ->t('Top Left'),
      'top_center' => $this
        ->t('Top Center'),
      'top_right' => $this
        ->t('Top Right'),
      'middle_left' => $this
        ->t('Middle Left'),
      'middle_center' => $this
        ->t('Middle Center'),
      'middle_right' => $this
        ->t('Middle Right'),
      'bottom_left' => $this
        ->t('Bottom Left'),
      'bottom_center' => $this
        ->t('Bottom Center'),
      'bottom_right' => $this
        ->t('Bottom Right'),
      'coordinate' => $this
        ->t('Coordinate'),
    ];
  }

  /**
   * Returns the token.tree_builder service, if available.
   *
   * @return \Drupal\token\TreeBuilderInterface|null
   *   The token.tree_builder service if available, NULL otherwise.
   */
  protected function getTokenTreeBuilder() {
    return \Drupal::hasService('token.tree_builder') ? \Drupal::service('token.tree_builder') : NULL;
  }

}

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
ImageWatermarkEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
ImageWatermarkEffect::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ImageWatermarkEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
ImageWatermarkEffect::getAlignPositions private function
ImageWatermarkEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
ImageWatermarkEffect::getTokenTreeBuilder protected function Returns the token.tree_builder service, if available.
ImageWatermarkEffect::submitConfigurationForm public function Form submission handler. Overrides ConfigurableImageEffectBase::submitConfigurationForm
ImageWatermarkEffect::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.