class ContainerDemo in Examples for Developers 3.x

Implements the container demo form.

This example demonstrates commonly used container elements in a form. Container elements are often used to group elements within a form.

The submit handler in this form is provided by the DemoBase class.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\form_api_example\Form\DemoBase
    • class \Drupal\form_api_example\Form\ContainerDemo

See also

\Drupal\Core\Form\FormBase

1 string reference to 'ContainerDemo'

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/ContainerDemo.php, line 17

Namespace

Drupal\form_api_example\Form

class ContainerDemo extends DemoBase {

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['description'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('This form example demonstrates container elements: details, fieldset and container.'),
    ];

    // Details containers replace D7's collapsible field sets.
    $form['author'] = [
      '#type' => 'details',
      '#title' => 'Author Info (type = details)',
    ];
    $form['author']['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Name'),
    ];
    $form['author']['pen_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pen Name'),
    ];

    // Conventional field set.
    $form['book'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Book Info (type = fieldset)'),
    ];
    $form['book']['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
    ];
    $form['book']['publisher'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Publisher'),
    ];

    // Containers have no visual display but wrap any contained elements in a
    // div tag.
    $form['accommodation'] = [
      '#type' => 'container',
    ];
    $form['accommodation']['title'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $this
        ->t('Special Accommodations (type = container)'),
    ];
    $form['accommodation']['diet'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Dietary Restrictions'),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerDemo::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ContainerDemo::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DemoBase::submitForm	public	function	Implements a form submit handler. Overrides FormInterface::submitForm	2
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
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.