You are here

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

class ImageBorder in Image effect kit 8

Defines IEK - Border operation.

Plugin annotation


@ImageToolkitOperation(
  id = "gd_iek_image_border",
  toolkit = "gd",
  operation = "iek_image_border",
  label = @Translation("IEK - Border"),
  description = @Translation("Add border to an image.")
)

Hierarchy

Expanded class hierarchy of ImageBorder

File

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

Namespace

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

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'border_color' => [
        'description' => 'Border color',
      ],
      'border_thick_top' => [
        'description' => 'Border thick - top',
      ],
      'border_thick_right' => [
        'description' => 'Border thick - right',
      ],
      'border_thick_bottom' => [
        'description' => 'Border thick - bottom',
      ],
      'border_thick_left' => [
        'description' => 'Border thick - left',
      ],
    ];
  }

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

    // TODO - validate color code.
    // Fail when border width is 0 or negative.
    if ((int) $arguments['border_thick_top'] <= 0) {
      throw new \InvalidArgumentException("Invalid border width ('{$arguments['border_thick_top']}') specified for the image 'iek_image_border' operation");
    }

    // Fail when border width is 0 or negative.
    if ((int) $arguments['border_thick_right'] <= 0) {
      throw new \InvalidArgumentException("Invalid border width ('{$arguments['border_thick_right']}') specified for the image 'iek_image_border' operation");
    }

    // Fail when border width is 0 or negative.
    if ((int) $arguments['border_thick_bottom'] <= 0) {
      throw new \InvalidArgumentException("Invalid border width ('{$arguments['border_thick_bottom']}') specified for the image 'iek_image_border' operation");
    }

    // Fail when border width is 0 or negative.
    if ((int) $arguments['border_thick_left'] <= 0) {
      throw new \InvalidArgumentException("Invalid border width ('{$arguments['border_thick_left']}') specified for the image 'iek_image_border' operation");
    }
    return $arguments;
  }

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments = []) {
    $data = $arguments;
    $border_color = $data['border_color'];
    $border_thick_top = $data['border_thick_top'];
    $border_thick_right = $data['border_thick_right'];
    $border_thick_bottom = $data['border_thick_bottom'];
    $border_thick_left = $data['border_thick_left'];
    $width = $this
      ->getToolkit()
      ->getWidth();
    $height = $this
      ->getToolkit()
      ->getHeight();
    $border_rgb = iek_hex2rgb($border_color);
    $bg_rgb = iek_hex2rgb('#ffffff');
    $dst = imagecreatetruecolor($width, $height);

    // Creates background.
    $bg = imagecolorallocate($dst, $bg_rgb['red'], $bg_rgb['green'], $bg_rgb['blue']);

    // Defines border color.
    $border_colors = imagecolorallocate($dst, $border_rgb['red'], $border_rgb['green'], $border_rgb['blue']);
    imagefilledrectangle($dst, 0, 0, $width, $height, $border_colors);
    imagefilledrectangle($dst, $border_thick_left, $border_thick_top, $width - $border_thick_right - 1, $height - $border_thick_bottom - 1, $bg);
    $this
      ->getToolkit()
      ->apply('iek_image_resize', [
      'width' => $width - ($border_thick_left + $border_thick_right),
      'height' => $height - ($border_thick_top + $border_thick_bottom),
      'blank_margin' => FALSE,
      'blank_margin_bg_color' => $border_color,
      'position' => 'middle_center',
      'x' => 0,
      'y' => 0,
    ]);
    if (!imagecopy($dst, $this
      ->getToolkit()
      ->getResource(), $border_thick_left, $border_thick_top, 0, 0, $width - ($border_thick_left + $border_thick_right), $height - ($border_thick_top + $border_thick_bottom))) {
      return FALSE;
    }
    imagedestroy($this
      ->getToolkit()
      ->getResource());

    // Update image object.
    $this
      ->getToolkit()
      ->setResource($dst);
    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
ImageBorder::arguments protected function Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
ImageBorder::execute protected function Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
ImageBorder::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.