You are here

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

class ImageOverlay in Image effect kit 8

Defines IEK - Overlay operation.

Plugin annotation


@ImageToolkitOperation(
  id = "gd_iek_image_overlay",
  toolkit = "gd",
  operation = "iek_image_overlay",
  label = @Translation("IEK - Overlay"),
  description = @Translation("Apply an overlay to an image.")
)

Hierarchy

Expanded class hierarchy of ImageOverlay

File

src/Plugin/ImageToolkit/Operation/gd/ImageOverlay.php, line 23
Contains \Drupal\iek\Plugin\ImageToolkit\Operation\gd\ImageOverlay.

Namespace

Drupal\iek\Plugin\ImageToolkit\Operation\gd
View source 
class ImageOverlay extends GDImageToolkitOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'overlay_name' => [
        'description' => 'Overlay name',
      ],
      'overlay_offset' => [
        'description' => 'Overlay offset',
      ],
      'bg_offset' => [
        'description' => 'Background offset',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function validateArguments(array $arguments) {

    // Fail when overlay offset is negative.
    if ((int) $arguments['overlay_offset'] < 0) {
      throw new \InvalidArgumentException("Invalid overlay offset ('{$arguments['overlay_offset']}') specified for the image 'iek_image_overlay' operation");
    }

    // Fail when bg offset is negative.
    if ((int) $arguments['bg_offset'] < 0) {
      throw new \InvalidArgumentException("Invalid bg offset ('{$arguments['bg_offset']}') specified for the image 'iek_image_overlay' operation");
    }
    return $arguments;
  }

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments = []) {
    $data = $arguments;
    $iek_overlay = iek_get_overlays($data['overlay_name']);
    $overlay_path = \Drupal::service('file_system')
      ->realpath($iek_overlay['path'] . '/' . $iek_overlay['file']);
    $overlay_info = iek_image_get_info($overlay_path);
    $overlay_tmp = iek_gd_create_image($overlay_path);
    imagecopyresampled($this
      ->getToolkit()
      ->getResource(), $overlay_tmp, $data['bg_offset'], $data['bg_offset'], $data['overlay_offset'], $data['overlay_offset'], $this
      ->getToolkit()
      ->getWidth() - $data['bg_offset'] * 2, $this
      ->getToolkit()
      ->getHeight() - $data['bg_offset'] * 2, $overlay_info['width'] - $data['overlay_offset'] * 2, $overlay_info['height'] - $data['overlay_offset'] * 2);
    return TRUE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
GDImageToolkitOperationBase::getToolkit protected function The correctly typed image toolkit for GD operations. Overrides ImageToolkitOperationBase::getToolkit
ImageOverlay::arguments protected function Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
ImageOverlay::execute protected function Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
ImageOverlay::validateArguments protected function Validates the arguments. Overrides ImageToolkitOperationBase::validateArguments
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::prepareArguments protected function Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::__construct public function Constructs an image toolkit operation plugin. 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.