interface UserMergePropertyPluginInterface in User Merge 2.x

Interface UserMergePropertyPluginInterface.

Plugin type which allow to inject process triggered on specific entities.

@package Drupal\usermerge\Plugin

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\usermerge\Plugin\UserMergePropertyPluginInterface

1 file declares its use of UserMergePropertyPluginInterface

UserMergePropertyBase.php in src/Plugin/UserMerge/Property/UserMergePropertyBase.php

File

src/Plugin/UserMergePropertyPluginInterface.php, line 16

Namespace

Drupal\usermerge\Plugin

interface UserMergePropertyPluginInterface extends PluginInspectionInterface, ContainerFactoryPluginInterface {

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

  /**
   * Get the review form if it is provided by the plugin.
   *
   * @return string
   *   Review name.
   */
  public function getReviewForm();

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

}

Members

Name	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
UserMergePropertyPluginInterface::getName	public	function	Return the name of the property plugin.	1
UserMergePropertyPluginInterface::getReviewForm	public	function	Get the review form if it is provided by the plugin.	1
UserMergePropertyPluginInterface::process	public	function	Process merge on selected property.	6