abstract class MultiStepFormBase in User Merge 2.x

Class MultiStepFormBase.

@package Drupal\usermerge\Form

View source

abstract class MultiStepFormBase extends FormBase {

  /**
   * Multi step storage.
   *
   * @var \Drupal\usermerge\MultiStepStorageInterface
   */
  protected $multiStepStorage;

  /**
   * Review form steps switcher.
   *
   * @var \Drupal\usermerge\ReviewFormSwitcherInterface
   */
  protected $reviewSwitcher;

  /**
   * Batch generator.
   *
   * @var \Drupal\usermerge\BatchGeneratorInterface
   */
  protected $batchGenerator;

  /**
   * MultiStepFormBase constructor.
   *
   * @param \Drupal\usermerge\MultiStepStorageInterface $multi_step_storage
   *   Multi step storage.
   * @param \Drupal\usermerge\ReviewFormSwitcherInterface $review_switcher
   *   Review form switcher.
   * @param \Drupal\usermerge\BatchGeneratorInterface $batch_generator
   *   Batch generator.
   */
  public function __construct(MultiStepStorageInterface $multi_step_storage, ReviewFormSwitcherInterface $review_switcher, BatchGeneratorInterface $batch_generator) {
    $this->multiStepStorage = $multi_step_storage;
    $this->reviewSwitcher = $review_switcher;
    $this->batchGenerator = $batch_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('usermerge.multi_step_storage'), $container
      ->get('usermerge.review_form_switcher'), $container
      ->get('usermerge.batch_generator'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['actions']['#type'] = 'actions';
    if ($this->reviewSwitcher
      ->hasPrevious(static::class)) {
      $form['actions']['previous'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Go back'),
        '#button_type' => 'primary',
        '#weight' => 10,
        '#submit' => [
          '::submitGoBack',
        ],
      ];
    }
    if ($this->reviewSwitcher
      ->hasNext(static::class)) {
      $form['actions']['next'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Continue'),
        '#button_type' => 'primary',
        '#weight' => 10,
        '#submit' => [
          '::submitForm',
          '::submitGoNext',
        ],
      ];
    }
    else {
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Merge accounts'),
        '#button_type' => 'primary',
        '#weight' => 10,
        '#submit' => [
          '::submitForm',
          '::submitCreateBatch',
        ],
      ];
    }
    return $form;
  }

  /**
   * Form submission for back button.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitGoBack(array &$form, FormStateInterface $form_state) {
    $previous = $this->reviewSwitcher
      ->getPreviousProperty(static::class);
    $form_state
      ->setRedirect('usermerge.multi_step_form', [
      'property' => $previous,
    ]);
  }

  /**
   * Form submission for next button.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitGoNext(array &$form, FormStateInterface $form_state) {
    $next = $this->reviewSwitcher
      ->getNextProperty(static::class);
    $form_state
      ->setRedirect('usermerge.multi_step_form', [
      'property' => $next,
    ]);
  }

  /**
   * Form submission for the last step.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitCreateBatch(array &$form, FormStateInterface $form_state) {
    $this->batchGenerator
      ->createBatch();
    $form_state
      ->setRedirect('usermerge.multi_step_form');
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Core\TempStore\TempStoreException
   */
  public final function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $property = $this->reviewSwitcher
      ->getPropertyFromForm(static::class);
    $this->multiStepStorage
      ->setValues($property, $values);
    $form_state
      ->setRedirect('usermerge.multi_step_form', [
      'property' => 'property_user',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	264
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
MultiStepFormBase::$batchGenerator	protected	property	Batch generator.
MultiStepFormBase::$multiStepStorage	protected	property	Multi step storage.
MultiStepFormBase::$reviewSwitcher	protected	property	Review form steps switcher.
MultiStepFormBase::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	2
MultiStepFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	1
MultiStepFormBase::submitCreateBatch	public	function	Form submission for the last step.
MultiStepFormBase::submitForm	final public	function	Overrides FormInterface::submitForm
MultiStepFormBase::submitGoBack	public	function	Form submission for back button.
MultiStepFormBase::submitGoNext	public	function	Form submission for next button.
MultiStepFormBase::__construct	public	function	MultiStepFormBase constructor.	1
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.

You are here

abstract class MultiStepFormBase in User Merge 2.x

Hierarchy

File

Namespace

Members

API Navigation