You are here

Home » API reference » Imagick 8 » Annotate.php

class Annotate in Imagick 8

Defines imagick annotate operation.

Plugin annotation


@ImageToolkitOperation(
  id = "imagick_annotate",
  toolkit = "imagick",
  operation = "annotate",
  label = @Translation("Annotate"),
  description = @Translation("Annotates an image resource")
)

Hierarchy

Expanded class hierarchy of Annotate

File

src/Plugin/ImageToolkit/Operation/imagick/Annotate.php, line 20

Namespace

Drupal\imagick\Plugin\ImageToolkit\Operation\imagick
View source 
class Annotate extends ImagickOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'text_fieldset' => [
        'description' => 'Text settings.',
      ],
      'position_fieldset' => [
        'description' => 'Position settings.',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function process(Imagick $resource, array $arguments) {
    $text = $arguments['text_fieldset'];
    $position = $arguments['position_fieldset'];
    $padding = [
      'x' => $position['padding_x'],
      'y' => $position['padding_y'],
    ];

    // Check if percent is used
    $percent_x = explode('%', $padding['x']);
    if (count($percent_x) == 2) {
      $padding['x'] = $resource
        ->getImageWidth() / 100 * reset($percent_x);
    }
    $percent_y = explode('%', $padding['y']);
    if (count($percent_y) == 2) {
      $padding['y'] = $resource
        ->getImageHeight() / 100 * reset($percent_y);
    }

    // Create new transparent layer
    $text_layer = new Imagick();
    $text_layer
      ->newImage($resource
      ->getImageWidth() - 2 * $padding['x'], $resource
      ->getImageHeight() - 2 * $padding['y'], new ImagickPixel('transparent'));

    // Font properties
    $draw = new ImagickDraw();
    $draw
      ->setFont($text['font']);
    $draw
      ->setFillColor($text['HEX']);
    $draw
      ->setFontSize($text['size']);

    // Calculate text width and height
    $imagick = new Imagick();
    list($lines, $lineHeight) = $this::_image_imagick_word_wrap_annotation($imagick, $draw, $text['text'], $text_layer
      ->getImageWidth());

    // Calcuate position
    $text_dimensions = $imagick
      ->queryFontMetrics($draw, $text['text']);
    $text_height = count($lines) * $lineHeight;
    list($left, $top) = explode('-', $position['anchor']);
    $y = image_filter_keyword($top, $text_layer
      ->getImageHeight(), $text_height);
    $y += $text_dimensions['textHeight'] + $text_dimensions['descender'];
    foreach ($lines as $line) {
      $line_dimensions = $imagick
        ->queryFontMetrics($draw, $line);
      $x = image_filter_keyword($left, $text_layer
        ->getImageWidth(), $line_dimensions['textWidth']);
      $text_layer
        ->annotateImage($draw, $x, $y, 0, $line);

      // Add lineheight for next line
      $y += $lineHeight;
    }
    return $resource
      ->compositeImage($text_layer, Imagick::COMPOSITE_OVER, $padding['x'], $padding['y']);
  }

  /**
   * Helper funtion to wrap text when it is to long
   *
   * @param Imagick $image
   * @param ImagickDraw $draw
   * @param string $text
   * @param int $maxWidth
   *
   * @return array
   */
  private function _image_imagick_word_wrap_annotation($image, $draw, $text, $maxWidth) {
    $text = trim($text);
    $words = preg_split('%\\s%', $text, -1, PREG_SPLIT_NO_EMPTY);
    $lines = [];
    $i = 0;
    $lineHeight = 0;
    while (count($words) > 0) {
      $metrics = $image
        ->queryFontMetrics($draw, implode(' ', array_slice($words, 0, ++$i)));
      $lineHeight = max($metrics['textHeight'], $lineHeight);

      // check if we have found the word that exceeds the line width
      if ($metrics['textWidth'] > $maxWidth or count($words) < $i) {

        // handle case where a single word is longer than the allowed line width (just add this as a word on its own line?)
        if ($i == 1) {
          $i++;
        }
        $lines[] = implode(' ', array_slice($words, 0, --$i));
        $words = array_slice($words, $i);
        $i = 0;
      }
    }
    return [
      $lines,
      $lineHeight,
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Annotate::arguments protected function Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
Annotate::process protected function
Annotate::_image_imagick_word_wrap_annotation private function Helper funtion to wrap text when it is to long
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
ImageToolkitOperationBase::$logger protected property A logger instance.
ImageToolkitOperationBase::$toolkit protected property The image toolkit.
ImageToolkitOperationBase::apply final public function Applies a toolkit specific operation to an image. Overrides ImageToolkitOperationInterface::apply
ImageToolkitOperationBase::getToolkit protected function Returns the image toolkit instance for this operation. 1
ImageToolkitOperationBase::prepareArguments protected function Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::validateArguments protected function Validates the arguments. 6
ImageToolkitOperationBase::__construct public function Constructs an image toolkit operation plugin. Overrides PluginBase::__construct
ImagickOperationTrait::execute protected function 3
ImagickOperationTrait::processFrames protected function Process image frames for GIFs
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.