You are here

Home » API reference » Examples for Developers 3.x » BuildDemo.php

class BuildDemo in Examples for Developers 3.x

Same name and namespace in other branches
  1. 8 form_api_example/src/Form/BuildDemo.php \Drupal\form_api_example\Form\BuildDemo

Implements the build demo form controller.

This example uses the Messenger service to demonstrate the order of controller method invocations by the form api.

Hierarchy

Expanded class hierarchy of BuildDemo

See also

\Drupal\Core\Form\FormBase

\Drupal\Core\Form\ConfigFormBase

1 string reference to 'BuildDemo'
form_api_example.routing.yml in modules/form_api_example/form_api_example.routing.yml
modules/form_api_example/form_api_example.routing.yml

File

modules/form_api_example/src/Form/BuildDemo.php, line 17

Namespace

Drupal\form_api_example\Form
View source 
class BuildDemo extends FormBase {

  /**
   * Counter keeping track of the sequence of method invocation.
   *
   * @var int
   */
  protected static $sequenceCounter = 0;

  /**
   * {@inheritdoc}
   */
  public function __construct() {
    $this
      ->displayMethodInvocation('__construct');
  }

  /**
   * Update form processing information.
   *
   * Display the method being called and it's sequence in the form
   * processing.
   *
   * @param string $method_name
   *   The method being invoked.
   */
  private function displayMethodInvocation($method_name) {
    self::$sequenceCounter++;
    $this
      ->messenger()
      ->addMessage(self::$sequenceCounter . ". {$method_name}");
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['description'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('Demonstrates how submit, rebuild, form-rebuild and #ajax submit work.'),
    ];

    // Simple checkbox for ajax orders.
    $form['change'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Change Me'),
      '#ajax' => [
        'callback' => '::ajaxSubmit',
        'wrapper' => 'message-wrapper',
      ],
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];

    // Add a submit button that handles the submission of the form.
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => 'Submit',
    ];

    // Add button handlers.
    $form['actions']['button'] = [
      '#type' => 'button',
      '#value' => 'Rebuild',
    ];
    $form['actions']['rebuild'] = [
      '#type' => 'submit',
      '#value' => 'Submit Rebuild',
      '#submit' => [
        '::rebuildFormSubmit',
      ],
    ];
    $form['actions']['ajaxsubmit'] = [
      '#type' => 'submit',
      '#value' => 'Ajax Submit',
      '#ajax' => [
        'callback' => '::ajaxSubmit',
        'wrapper' => 'message-wrapper',
      ],
    ];
    $form['messages'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => 'message-wrapper',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    $this
      ->displayMethodInvocation('getFormId');
    return 'form_api_example_build_form';
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $this
      ->displayMethodInvocation('validateForm');
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->displayMethodInvocation('submitForm');
  }

  /**
   * Implements ajax submit callback.
   *
   * @param array $form
   *   Form render array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current state of the form.
   */
  public function ajaxSubmit(array &$form, FormStateInterface $form_state) {
    $this
      ->displayMethodInvocation('ajaxSubmit');
    $form['messages']['status'] = [
      '#type' => 'status_messages',
    ];
    return $form['messages'];
  }

  /**
   * Implements submit callback for Rebuild button.
   *
   * @param array $form
   *   Form render array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current state of the form.
   */
  public function rebuildFormSubmit(array &$form, FormStateInterface $form_state) {
    $this
      ->displayMethodInvocation('rebuildFormSubmit');
    $form_state
      ->setRebuild(TRUE);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BuildDemo::$sequenceCounter protected static property Counter keeping track of the sequence of method invocation.
BuildDemo::ajaxSubmit public function Implements ajax submit callback.
BuildDemo::buildForm public function Form constructor. Overrides FormInterface::buildForm
BuildDemo::displayMethodInvocation private function Update form processing information.
BuildDemo::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BuildDemo::rebuildFormSubmit public function Implements submit callback for Rebuild button.
BuildDemo::submitForm public function Form submission handler. Overrides FormInterface::submitForm
BuildDemo::validateForm public function Form validation handler. Overrides FormBase::validateForm
BuildDemo::__construct public function
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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.
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.
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.