You are here

class Mask in Image Effects 8.3

Same name in this branch
  1. 8.3 src/Plugin/ImageToolkit/Operation/gd/Mask.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\Mask
  2. 8.3 src/Plugin/ImageToolkit/Operation/imagemagick/Mask.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\imagemagick\Mask
Same name and namespace in other branches
  1. 8 src/Plugin/ImageToolkit/Operation/gd/Mask.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\Mask
  2. 8.2 src/Plugin/ImageToolkit/Operation/gd/Mask.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\Mask

Defines GD Mask operation.

Plugin annotation


@ImageToolkitOperation(
  id = "image_effects_gd_mask",
  toolkit = "gd",
  operation = "mask",
  label = @Translation("Mask"),
  description = @Translation("Applies a mask to the source image.")
)

Hierarchy

Expanded class hierarchy of Mask

File

src/Plugin/ImageToolkit/Operation/gd/Mask.php, line 19

Namespace

Drupal\image_effects\Plugin\ImageToolkit\Operation\gd
View source
class Mask extends GDImageToolkitOperationBase {
  use MaskTrait;

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments) {
    $mask = $arguments['mask_image'];
    $x_offset = $arguments['x_offset'];
    $y_offset = $arguments['y_offset'];

    // Resize mask if needed.
    if ($arguments['mask_width'] || $arguments['mask_height']) {
      $mask
        ->apply('resize', [
        'width' => $arguments['mask_width'],
        'height' => $arguments['mask_height'],
      ]);
    }

    // Preserves original resource, to be destroyed upon success.
    $original_resource = $this
      ->getToolkit()
      ->getResource();

    // Prepare a new image.
    $data = [
      'width' => $this
        ->getToolkit()
        ->getWidth(),
      'height' => $this
        ->getToolkit()
        ->getHeight(),
      'extension' => image_type_to_extension($this
        ->getToolkit()
        ->getType(), FALSE),
      'transparent_color' => $this
        ->getToolkit()
        ->getTransparentColor(),
      'is_temp' => TRUE,
    ];
    if (!$this
      ->getToolkit()
      ->apply('create_new', $data)) {

      // In case of failure, destroy the temporary resource and restore
      // the original one.
      imagedestroy($this
        ->getToolkit()
        ->getResource());
      $this
        ->getToolkit()
        ->setResource($original_resource);
      return FALSE;
    }

    // Force a transparent color fill to prevent JPEG to end up as a white
    // mask, while in memory.
    imagefill($this
      ->getToolkit()
      ->getResource(), 0, 0, imagecolorallocatealpha($this
      ->getToolkit()
      ->getResource(), 0, 0, 0, 127));

    // Perform pixel-based alpha map application.
    for ($x = 0; $x < $mask
      ->getToolkit()
      ->getWidth(); $x++) {
      for ($y = 0; $y < $mask
        ->getToolkit()
        ->getHeight(); $y++) {

        // Deal with images with mismatched sizes.
        if ($x + $x_offset >= imagesx($original_resource) || $y + $y_offset >= imagesy($original_resource) || $x + $x_offset < 0 || $y + $y_offset < 0) {
          continue;
        }
        else {
          $alpha = imagecolorsforindex($mask
            ->getToolkit()
            ->getResource(), imagecolorat($mask
            ->getToolkit()
            ->getResource(), $x, $y));
          $alpha = 127 - floor($alpha['red'] / 2);
          $color = imagecolorsforindex($this
            ->getToolkit()
            ->getResource(), imagecolorat($original_resource, $x + $x_offset, $y + $y_offset));
          imagesetpixel($this
            ->getToolkit()
            ->getResource(), $x + $x_offset, $y + $y_offset, imagecolorallocatealpha($this
            ->getToolkit()
            ->getResource(), $color['red'], $color['green'], $color['blue'], $alpha));
        }
      }
    }

    // Destroy original picture.
    imagedestroy($original_resource);
    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
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
Mask::execute protected function Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
MaskTrait::arguments protected function
MaskTrait::validateArguments protected function
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.