class Replace in Image Replace 8

Defines GD2 image_replace operation.

Plugin annotation

@ImageToolkitOperation(
  id = "image_replace_gd",
  toolkit = "gd",
  operation = "image_replace",
  label = @Translation("Replace"),
  description = @Translation("Swap the original image with a replacement image."),
)

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_replace\Plugin\ImageToolkit\Operation\gd\Replace

File

src/Plugin/ImageToolkit/Operation/gd/Replace.php, line 20

Namespace

Drupal\image_replace\Plugin\ImageToolkit\Operation\gd

class Replace extends GDImageToolkitOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'replacement_image' => [
        'description' => 'The replacement image',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function validateArguments(array $arguments) {
    if (!($arguments['replacement_image'] instanceof ImageInterface || !$arguments['replacement_image']
      ->getToolkit() instanceof GDToolkit)) {
      throw new \InvalidArgumentException("Invalid replacement image specified for the 'image_replace' operation.");
    }
    return $arguments;
  }

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

    // Create a new resource of the required dimensions, and replace the
    // original resource on it with resampling. Destroy the original resource
    // upon success.
    $replacement_toolkit = $this
      ->getReplacementImageToolkit($arguments);
    $original_resource = $this
      ->getToolkit()
      ->getResource();
    $data = [
      'width' => $replacement_toolkit
        ->getWidth(),
      'height' => $replacement_toolkit
        ->getHeight(),
      'extension' => image_type_to_extension($this
        ->getToolkit()
        ->getType(), FALSE),
      'transparent_color' => $replacement_toolkit
        ->getTransparentColor(),
      'is_temp' => TRUE,
    ];
    if ($this
      ->getToolkit()
      ->apply('create_new', $data)) {
      if (imagecopy($this
        ->getToolkit()
        ->getResource(), $replacement_toolkit
        ->getResource(), 0, 0, 0, 0, $data['width'], $data['height'])) {
        imagedestroy($original_resource);
        return TRUE;
      }
      else {

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

  /**
   * Returns the correctly typed replacement image toolkit for GD operations.
   *
   * @param array $arguments
   *   An associative array of data to be used by the toolkit operation.
   *
   * @return \Drupal\system\Plugin\ImageToolkit\GDToolkit
   *   The correctly typed replacement image toolkit for GD operations.
   */
  protected function getReplacementImageToolkit(array $arguments = []) {
    return $arguments['replacement_image']
      ->getToolkit();
  }

}

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.
Replace::arguments	protected	function	Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
Replace::execute	protected	function	Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
Replace::getReplacementImageToolkit	protected	function	Returns the correctly typed replacement image toolkit for GD operations.
Replace::validateArguments	protected	function	Validates the arguments. Overrides ImageToolkitOperationBase::validateArguments
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.