interface MultiStepStorageInterface in User Merge 2.x

Interface MultiStepStorageInterface.

Helper which allows to store review data.

@package Drupal\usermerge

Hierarchy

• interface \Drupal\usermerge\MultiStepStorageInterface

2 files declare their use of MultiStepStorageInterface

MultiStepFormBase.php in src/Form/MultiStepFormBase.php

PickAccountsForm.php in src/Form/PickAccountsForm.php

File

src/MultiStepStorageInterface.php, line 12

Namespace

Drupal\usermerge

interface MultiStepStorageInterface {

  /**
   * Get default value.
   *
   * @param string $property
   *   Id of property plugin.
   * @param string $name
   *   Field name.
   *
   * @return string|null
   *   Field value.
   */
  public function getValueFromStore($property, $name);

  /**
   * Get stored values.
   *
   * @param string $property
   *   Id of property plugin.
   *
   * @return array
   *   Field value.
   */
  public function getValuesFromStore($property);

  /**
   * Save form values in store.
   *
   * @param string $property
   *   Id of property plugin.
   * @param array $values
   *   An associative array of values submitted to the form.
   *
   * @throws \Drupal\Core\TempStore\TempStoreException
   */
  public function setValues($property, array $values) : void;

  /**
   * Get retired account.
   *
   * @return \Drupal\user\UserInterface|null
   *   Retired account.
   */
  public function getRetiredAccount();

  /**
   * Get retained account.
   *
   * @return \Drupal\user\UserInterface|null
   *   Retained account.
   */
  public function getRetainedAccount();

  /**
   * Remove all settings from store.
   *
   * @param string $property
   *   Id of property plugin.
   */
  public function delete($property) : void;

}

Members

Name	Modifiers	Type	Description	Overrides
MultiStepStorageInterface::delete	public	function	Remove all settings from store.	1
MultiStepStorageInterface::getRetainedAccount	public	function	Get retained account.	1
MultiStepStorageInterface::getRetiredAccount	public	function	Get retired account.	1
MultiStepStorageInterface::getValueFromStore	public	function	Get default value.	1
MultiStepStorageInterface::getValuesFromStore	public	function	Get stored values.	1
MultiStepStorageInterface::setValues	public	function	Save form values in store.	1