class ReplaceImage in Image Effects 8.3

Defines GD2 image replace operation.

Plugin annotation

@ImageToolkitOperation(
  id = "image_effects_gd_replace_image",
  toolkit = "gd",
  operation = "replace_image",
  label = @Translation("Replace image"),
  description = @Translation("Replace the current image with another one.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
      • class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
        • class \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\ReplaceImage uses ReplaceImageTrait

File

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

Namespace

Drupal\image_effects\Plugin\ImageToolkit\Operation\gd

class ReplaceImage extends GDImageToolkitOperationBase {
  use ReplaceImageTrait;

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

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

    // Overlay replacement image.
    $data = [
      'watermark_image' => $arguments['replacement_image'],
      'x_offset' => 0,
      'y_offset' => 0,
    ];
    return $this
      ->getToolkit()
      ->apply('watermark', $data);
  }

}

Members

Name	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
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.
ReplaceImage::execute	protected	function	Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
ReplaceImageTrait::arguments	protected	function
ReplaceImageTrait::validateArguments	protected	function
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.