interface ReviewFormSwitcherInterface in User Merge 2.x

Interface ReviewFormSwitcherInterface.

Helper which allows to move around the review forms.

@package Drupal\usermerge

Hierarchy

• interface \Drupal\usermerge\ReviewFormSwitcherInterface

3 files declare their use of ReviewFormSwitcherInterface

MultiStepFormBase.php in src/Form/MultiStepFormBase.php

MultiStepFormController.php in src/Controller/MultiStepFormController.php

PickAccountsForm.php in src/Form/PickAccountsForm.php

File

src/ReviewFormSwitcherInterface.php, line 12

Namespace

Drupal\usermerge

interface ReviewFormSwitcherInterface {

  /**
   * Check if we have the previous form.
   *
   * @param string $class
   *   Multi step form class name.
   *
   * @return bool
   *   Check if we have a previous form.
   */
  public function hasPrevious($class) : bool;

  /**
   * Check if we have the next form.
   *
   * @param string $class
   *   Multi step form class name.
   *
   * @return bool
   *   Check if we have a next form.
   */
  public function hasNext($class) : bool;

  /**
   * Get previous property.
   *
   * @param string $class
   *   Multi step form class name.
   *
   * @return string
   *   If of the property plugin.
   */
  public function getPreviousProperty($class) : string;

  /**
   * Get next property.
   *
   * @param string $class
   *   Multi step form class name.
   *
   * @return string
   *   If of the property plugin.
   */
  public function getNextProperty($class) : string;

  /**
   * Get class name.
   *
   * @param string $property
   *   Id of the property plugin type.
   *
   * @return string
   *   Class name of the form
   *
   * @throws \Drupal\usermerge\Exception\UserMergeException
   */
  public function getFormFromProperty($property) : string;

  /**
   * Get id of property.
   *
   * @param string $class
   *   Multi step form class name.
   *
   * @return string
   *   Property id.
   */
  public function getPropertyFromForm($class) : string;

}

Members

Name	Modifiers	Type	Description	Overrides
ReviewFormSwitcherInterface::getFormFromProperty	public	function	Get class name.	1
ReviewFormSwitcherInterface::getNextProperty	public	function	Get next property.	1
ReviewFormSwitcherInterface::getPreviousProperty	public	function	Get previous property.	1
ReviewFormSwitcherInterface::getPropertyFromForm	public	function	Get id of property.	1
ReviewFormSwitcherInterface::hasNext	public	function	Check if we have the next form.	1
ReviewFormSwitcherInterface::hasPrevious	public	function	Check if we have the previous form.	1