class Wizard in Examples for Developers 8

Same name and namespace in other branches

3.x modules/ajax_example/src/Form/Wizard.php \Drupal\ajax_example\Form\Wizard

AJAX example wizard.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ajax_example\Form\Wizard

Expanded class hierarchy of Wizard

1 string reference to 'Wizard'

ajax_example.routing.yml in ajax_example/ajax_example.routing.yml: ajax_example/ajax_example.routing.yml

File

ajax_example/src/Form/Wizard.php, line 14

Namespace

Drupal\ajax_example\Form

View source

class Wizard extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ajax_example_wizard';
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    // Since FormBase uses service traits, we can inject these services without
    // adding our own __construct() method.
    $form = new static($container);
    $form
      ->setStringTranslation($container
      ->get('string_translation'));
    $form
      ->setMessenger($container
      ->get('messenger'));
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $no_js_use = FALSE) {
    $url = Url::fromUri('internal:/examples/ajax-example/wizard-nojs');
    $link = Link::fromTextAndUrl($this
      ->t('examples/ajax-example/wizard-nojs'), $url)
      ->toString();

    // Prepare link for multiple arguments.
    $urltwo = Url::fromUri('internal:/examples/ajax-example/wizard');
    $linktwo = Link::fromTextAndUrl($this
      ->t('examples/ajax-example/wizard'), $urltwo)
      ->toString();

    // We want to deal with hierarchical form values.
    $form['#tree'] = TRUE;
    $form['description'] = [
      '#markup' => $this
        ->t('This example is a step-by-step wizard. The @link does it without page reloads; the @link1 is the same code but simulates a non-javascript environment, showing it with page reloads.', [
        '@link' => $linktwo,
        '@link1' => $link,
      ]),
    ];
    $form['step'] = [
      '#type' => 'value',
      '#value' => !empty($form_state
        ->getValue('step')) ? $form_state
        ->getValue('step') : 1,
    ];
    switch ($form['step']['#value']) {
      case 1:
        $limit_validation_errors = [
          [
            'step',
          ],
        ];
        $form['step1'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Step 1: Personal details'),
        ];
        $form['step1']['name'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Your name'),
          '#default_value' => $form_state
            ->hasValue([
            'step1',
            'name',
          ]) ? $form_state
            ->getValue([
            'step1',
            'name',
          ]) : '',
          '#required' => TRUE,
        ];
        break;
      case 2:
        $limit_validation_errors = [
          [
            'step',
          ],
          [
            'step1',
          ],
        ];
        $form['step1'] = [
          '#type' => 'value',
          '#value' => $form_state
            ->getValue('step1'),
        ];
        $form['step2'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Step 2: Street address info'),
        ];
        $form['step2']['address'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Your street address'),
          '#default_value' => $form_state
            ->hasValue([
            'step2',
            'address',
          ]) ? $form_state
            ->getValue([
            'step2',
            'address',
          ]) : '',
          '#required' => TRUE,
        ];
        break;
      case 3:
        $limit_validation_errors = [
          [
            'step',
          ],
          [
            'step1',
          ],
          [
            'step2',
          ],
        ];
        $form['step1'] = [
          '#type' => 'value',
          '#value' => $form_state
            ->getValue('step1'),
        ];
        $form['step2'] = [
          '#type' => 'value',
          '#value' => $form_state
            ->getValue('step2'),
        ];
        $form['step3'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Step 3: City info'),
        ];
        $form['step3']['city'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Your city'),
          '#default_value' => $form_state
            ->hasValue([
            'step3',
            'city',
          ]) ? $form_state
            ->getValue([
            'step3',
            'city',
          ]) : '',
          '#required' => TRUE,
        ];
        break;
      default:
        $limit_validation_errors = [];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    if ($form['step']['#value'] > 1) {
      $form['actions']['prev'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Previous step'),
        '#limit_validation_errors' => $limit_validation_errors,
        '#submit' => [
          '::prevSubmit',
        ],
        '#ajax' => [
          'wrapper' => 'ajax-example-wizard-wrapper',
          'callback' => '::prompt',
        ],
      ];
    }
    if ($form['step']['#value'] != 3) {
      $form['actions']['next'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Next step'),
        '#submit' => [
          '::nextSubmit',
        ],
        '#ajax' => [
          'wrapper' => 'ajax-example-wizard-wrapper',
          'callback' => '::prompt',
        ],
      ];
    }
    if ($form['step']['#value'] == 3) {
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t("Submit your information"),
      ];
    }

    // This simply allows us to demonstrate no-javascript use without
    // actually turning off javascript in the browser. Removing the #ajax
    // element turns off AJAX behaviors on that element and as a result
    // ajax.js doesn't get loaded.
    // For demonstration only! You don't need this.
    if ($no_js_use) {

      // Remove the #ajax from the above, so ajax.js won't be loaded.
      // For demonstration only.
      unset($form['actions']['next']['#ajax']);
      unset($form['actions']['prev']['#ajax']);
    }
    $form['#prefix'] = '<div id="ajax-example-wizard-wrapper">';
    $form['#suffix'] = '</div>';
    return $form;
  }

  /**
   * Wizard callback function.
   *
   * @param array $form
   *   Form API form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form API form.
   *
   * @return array
   *   Form array.
   */
  public function prompt(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * Ajax callback that moves the form to the next step and rebuild the form.
   *
   * @param array $form
   *   The Form API form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The FormState object.
   *
   * @return array
   *   The Form API form.
   */
  public function nextSubmit(array $form, FormStateInterface $form_state) {
    $form_state
      ->setValue('step', $form_state
      ->getValue('step') + 1);
    $form_state
      ->setRebuild();
    return $form;
  }

  /**
   * Ajax callback that moves the form to the previous step.
   *
   * @param array $form
   *   The Form API form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The FormState object.
   *
   * @return array
   *   The Form API form.
   */
  public function prevSubmit(array $form, FormStateInterface $form_state) {
    $form_state
      ->setValue('step', $form_state
      ->getValue('step') - 1);
    $form_state
      ->setRebuild();
    return $form;
  }

  /**
   * Save away the current information.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $messenger = $this
      ->messenger();
    $messenger
      ->addMessage($this
      ->t('Your information has been submitted:'));
    $messenger
      ->addMessage($this
      ->t('Name: @name', [
      '@name' => $form_state
        ->getValue([
        'step1',
        'name',
      ]),
    ]));
    $messenger
      ->addMessage($this
      ->t('Address: @address', [
      '@address' => $form_state
        ->getValue([
        'step2',
        'address',
      ]),
    ]));
    $messenger
      ->addMessage($this
      ->t('City: @city', [
      '@city' => $form_state
        ->getValue([
        'step3',
        'city',
      ]),
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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. Overrides UrlGeneratorTrait::redirect
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	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.
Wizard::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
Wizard::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
Wizard::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
Wizard::nextSubmit	public	function	Ajax callback that moves the form to the next step and rebuild the form.
Wizard::prevSubmit	public	function	Ajax callback that moves the form to the previous step.
Wizard::prompt	public	function	Wizard callback function.
Wizard::submitForm	public	function	Save away the current information. Overrides FormInterface::submitForm

You are here

class Wizard in Examples for Developers 8

Hierarchy

File

Namespace

Members

API Navigation