You are here

interface UserMergeActionPluginInterface in User Merge 2.x

Interface UserMergeActionPluginInterface.

Plugin type which allow to inject a custom action.

@package Drupal\usermerge\Plugin

Hierarchy

Expanded class hierarchy of UserMergeActionPluginInterface

All classes that implement UserMergeActionPluginInterface

1 file declares its use of UserMergeActionPluginInterface
UserMergeActionBase.php in src/Plugin/UserMerge/Action/UserMergeActionBase.php

File

src/Plugin/UserMergeActionPluginInterface.php, line 16

Namespace

Drupal\usermerge\Plugin
View source
interface UserMergeActionPluginInterface extends PluginInspectionInterface, ContainerFactoryPluginInterface {

  /**
   * Return the name of the action merge plugin.
   *
   * @return string
   *   Action name.
   */
  public function getName();

  /**
   * Process merge on selected property.
   *
   * @param \Drupal\user\UserInterface $retired
   *   Retired account.
   * @param \Drupal\user\UserInterface $retained
   *   Retained account.
   *
   * @throws \Drupal\usermerge\Exception\UserMergeException
   */
  public function process(UserInterface $retired, UserInterface $retained) : void;

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 120
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
UserMergeActionPluginInterface::getName public function Return the name of the action merge plugin. 1
UserMergeActionPluginInterface::process public function Process merge on selected property. 2