StepChangeEvent.php in Forms Steps 8

Namespace

Drupal\forms_steps\Event

File

src/Event/StepChangeEvent.php

<?php

namespace Drupal\forms_steps\Event;

use Drupal\Core\Form\FormState;
use Drupal\forms_steps\Entity\FormsSteps;
use Drupal\forms_steps\Step;
use Symfony\Component\EventDispatcher\Event;

/**
 * Event that is fired when before we switch from one step to another.
 */
class StepChangeEvent extends Event {
  const STEP_CHANGE_EVENT = 'forms_steps.step_change_event';

  /**
   * The FormsSteps object.
   *
   * @var \Drupal\forms_steps\Entity\FormsSteps
   */
  public $formsSteps;

  /**
   * The current step.
   *
   * @var \Drupal\forms_steps\StepInterface
   */
  public $fromStep;

  /**
   * The step we are jumping to (can be previous one or next one).
   *
   * @var \Drupal\forms_steps\StepInterface
   */
  public $toStep;

  /**
   * The formState object.
   *
   * @var \Drupal\Core\Form\FormState
   */
  public $formState;

  /**
   * Constructs the object.
   *
   * @param \Drupal\forms_steps\Entity\FormsSteps $forms_steps
   *  The FormsSteps object.
   * @param \Drupal\forms_steps\Step $from_step
   *  The step the user is currently on.
   * @param \Drupal\forms_steps\Step $to_step
   *  The next/previous step the user is going to be redirected.
   * @param FormState $form_state
   *  The formState.
   */
  public function __construct(FormsSteps $forms_steps, Step $from_step, Step $to_step, FormState $form_state) {
    $this->formsSteps = $forms_steps;
    $this->fromStep = $from_step;
    $this->toStep = $to_step;
    $this->formState = $form_state;
  }

}

Classes

Name	Description
StepChangeEvent	Event that is fired when before we switch from one step to another.