You are here

Home » API reference » Basic Watermark 8 » AddWatermarkEffect.php

class AddWatermarkEffect in Basic Watermark 8

Converts an image resource.

Plugin annotation


@ImageEffect(
  id = "add_watermark",
  label = @Translation("Add Watermark"),
  description = @Translation("Adds watermark to the image")
)

Hierarchy

Expanded class hierarchy of AddWatermarkEffect

File

src/Plugin/ImageEffect/AddWatermarkEffect.php, line 18

Namespace

Drupal\basic_watermark\Plugin\ImageEffect
View source 
class AddWatermarkEffect extends ConfigurableImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $result = $image
      ->apply('add_watermark', $this->configuration);
    if (!$result) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'watermark_path' => NULL,
      'apply_type' => 'once',
      'position' => 'center-center',
      'margins' => [
        'left' => 0,
        'top' => 0,
        'right' => 0,
        'bottom' => 0,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary['watermark_path'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t("Watermark path: @path", [
        '@path' => $this->configuration['watermark_path'],
      ]),
    ];
    $summary['apply_type'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t("Apply type: @path", [
        '@path' => $this
          ->getApplyTypeOptions()[$this->configuration['apply_type']],
      ]),
    ];
    $summary['position'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t("Position: @path", [
        '@path' => $this
          ->getPositionOptions()[$this->configuration['position']],
      ]),
    ];
    $summary += parent::getSummary();
    return $summary;
  }

  /**
   * The watermark apply types.
   *
   * @return array
   *   An array with the options.
   */
  public function getApplyTypeOptions() {
    return [
      'once' => $this
        ->t('Once'),
      'repeat' => $this
        ->t('Repeat'),
    ];
  }

  /**
   * The watermark position options.
   *
   * @return array
   *   An array with the options.
   */
  public function getPositionOptions() {
    return [
      'left-top' => $this
        ->t('Top left'),
      'center-top' => $this
        ->t('Top center'),
      'right-top' => $this
        ->t('Top right'),
      'left-center' => $this
        ->t('Center left'),
      'center-center' => $this
        ->t('Center'),
      'right-center' => $this
        ->t('Center right'),
      'left-bottom' => $this
        ->t('Bottom left'),
      'center-bottom' => $this
        ->t('Bottom center'),
      'right-bottom' => $this
        ->t('Bottom right'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['watermark_path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Watermark path'),
      '#description' => $this
        ->t('Example: /sites/default/files/watermark.png, The image must be in png format and the path must be insite drupal root.'),
      '#default_value' => $this->configuration['watermark_path'],
      '#required' => TRUE,
    ];
    $form['apply_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Apply type'),
      '#description' => $this
        ->t('<ul>
        <li><label>Once:</label> Add the watermark once.</li>
        <li><label>Repeat:</label> Repeat the watermark from top left until it covers the the whole image.</li>
        </ul>
      '),
      '#options' => $this
        ->getApplyTypeOptions(),
      '#default_value' => $this->configuration['apply_type'],
    ];
    $form['position_wrapper'] = [
      '#type' => 'container',
      '#states' => [
        'visible' => [
          'select[name="data[apply_type]"' => [
            'value' => 'once',
          ],
        ],
      ],
      'position' => [
        '#theme' => 'image_anchor',
        '#type' => 'radios',
        '#title' => $this
          ->t('Position'),
        '#options' => $this
          ->getPositionOptions(),
        '#default_value' => $this->configuration['position'],
        '#description' => $this
          ->t('Watermark position'),
      ],
    ];
    $form['margins'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Watermark margins'),
      '#description' => $this
        ->t('Empty area to keep around the watermark in pixels.'),
      'left' => [
        '#title' => $this
          ->t('Margin left'),
        '#type' => 'textfield',
        '#default_value' => $this->configuration['margins']['left'],
        '#required' => TRUE,
      ],
      'top' => [
        '#title' => $this
          ->t('Margin top'),
        '#type' => 'textfield',
        '#default_value' => $this->configuration['margins']['top'],
        '#required' => TRUE,
      ],
      'right' => [
        '#title' => $this
          ->t('Margin right'),
        '#type' => 'textfield',
        '#default_value' => $this->configuration['margins']['right'],
        '#required' => TRUE,
      ],
      'bottom' => [
        '#title' => $this
          ->t('Margin bottom'),
        '#type' => 'textfield',
        '#default_value' => $this->configuration['margins']['bottom'],
        '#required' => TRUE,
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $path = DRUPAL_ROOT . $form_state
      ->getValue('watermark_path');
    if (!file_exists($path)) {
      $form_state
        ->setError($form['watermark_path'], $this
        ->t('File does not exist.'));
    }
    else {
      $image_details = getimagesize($path);
      if (!$image_details || $image_details['mime'] != 'image/png') {
        $form_state
          ->setError($form['watermark_path'], $this
          ->t('File not a png.'));
      }
    }
    $margins = $form_state
      ->getValue('margins');
    foreach ($margins as $field => $margin) {
      if ($margin !== '' && (!is_numeric($margin) || intval($margin) != $margin || $margin < 0)) {
        $form_state
          ->setError($form['margins'][$field], $this
          ->t('%name must be a non negative integer.', [
          '%name' => $form['margins'][$field]['#title'],
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['watermark_path'] = $form_state
      ->getValue('watermark_path');
    $this->configuration['apply_type'] = $form_state
      ->getValue('apply_type');
    $this->configuration['position'] = $form_state
      ->getValue('position_wrapper')['position'];
    $this->configuration['margins'] = $form_state
      ->getValue('margins');
    if ($this->configuration['apply_type'] == 'repeat') {
      $this->configuration['position'] = 'left-top';
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddWatermarkEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
AddWatermarkEffect::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
AddWatermarkEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
AddWatermarkEffect::getApplyTypeOptions public function The watermark apply types.
AddWatermarkEffect::getPositionOptions public function The watermark position options.
AddWatermarkEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
AddWatermarkEffect::submitConfigurationForm public function Form submission handler. Overrides ConfigurableImageEffectBase::submitConfigurationForm
AddWatermarkEffect::validateConfigurationForm public function Form validation handler. Overrides ConfigurableImageEffectBase::validateConfigurationForm
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.