You are here

class AnnotateImageEffect in Imagick 8

Annotates an image resource.

Plugin annotation


@ImageEffect(
  id = "image_annotate",
  label = @Translation("Annotate"),
  description = @Translation("Annotates an image resource.")
)

Hierarchy

Expanded class hierarchy of AnnotateImageEffect

File

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

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image
      ->apply('annotate', $this->configuration)) {
      $this->logger
        ->error('Image annotate 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 [
      'text_fieldset' => [
        'text' => 'Annotation',
        'font' => 'Helvetica',
        'size' => 20,
        'HEX' => '#000000',
      ],
      'position_fieldset' => [
        'anchor' => 'right-bottom',
        'padding_x' => 20,
        'padding_y' => 20,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'colorform',
        ],
      ],
    ];

    // Get fonts
    $imagick = new Imagick();
    $available_fonts = $imagick
      ->queryFonts();
    $form['text_fieldset'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Text'),
      'text' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Text'),
        '#description' => $this
          ->t('Text to annotate the image with.'),
        '#default_value' => $this->configuration['text_fieldset']['text'],
      ],
      'font' => [
        '#type' => 'select',
        '#options' => array_combine($available_fonts, $available_fonts),
        '#title' => $this
          ->t('Font'),
        '#description' => $this
          ->t('Fonts that ImageMagick knows about.'),
        '#default_value' => $this->configuration['text_fieldset']['font'],
      ],
      'size' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Font size'),
        '#default_value' => $this->configuration['text_fieldset']['size'],
        '#size' => 3,
      ],
    ];
    $form['text_fieldset']['HEX'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('HEX'),
      '#default_value' => $this->configuration['text_fieldset']['HEX'],
      '#attributes' => [
        'class' => [
          'colorentry',
        ],
      ],
    ];
    $form['text_fieldset']['colorpicker'] = [
      '#weight' => -1,
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'colorpicker',
        ],
        'style' => [
          'float:right',
        ],
      ],
    ];

    // Add Farbtastic color picker.
    $form['text_fieldset']['matte_color']['#attached'] = [
      'library' => [
        'imagick/colorpicker',
      ],
    ];
    $form['position_fieldset'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Position'),
      'anchor' => [
        '#type' => 'radios',
        '#title' => $this
          ->t('Anchor'),
        '#options' => [
          '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'),
        ],
        '#theme' => 'image_anchor',
        '#default_value' => $this->configuration['position_fieldset']['anchor'],
      ],
      'padding_x' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Padding X'),
        '#default_value' => $this->configuration['position_fieldset']['padding_x'],
        '#description' => $this
          ->t('Enter a value in pixels or percent'),
        '#size' => 3,
      ],
      'padding_y' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Padding Y'),
        '#default_value' => $this->configuration['position_fieldset']['padding_y'],
        '#description' => $this
          ->t('Enter a value in pixels or percent'),
        '#size' => 3,
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['text_fieldset']['text'] = $form_state
      ->getValue([
      'text_fieldset',
      'text',
    ]);
    $this->configuration['text_fieldset']['font'] = $form_state
      ->getValue([
      'text_fieldset',
      'font',
    ]);
    $this->configuration['text_fieldset']['size'] = $form_state
      ->getValue([
      'text_fieldset',
      'size',
    ]);
    $this->configuration['text_fieldset']['HEX'] = $form_state
      ->getValue([
      'text_fieldset',
      'HEX',
    ]);
    $this->configuration['position_fieldset']['anchor'] = $form_state
      ->getValue([
      'position_fieldset',
      'anchor',
    ]);
    $this->configuration['position_fieldset']['padding_x'] = $form_state
      ->getValue([
      'position_fieldset',
      'padding_x',
    ]);
    $this->configuration['position_fieldset']['padding_y'] = $form_state
      ->getValue([
      'position_fieldset',
      'padding_y',
    ]);
  }

}

Members

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