W3cubDocs

/Drupal 8

public function EntityForm::buildForm

public EntityForm::buildForm(array $form, FormStateInterface $form_state)

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

core/lib/Drupal/Core/Entity/EntityForm.php, line 101

Class

EntityForm
Base class for entity forms.

Namespace

Drupal\Core\Entity

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  // During the initial form build, add this form object to the form state and
  // allow for initial preparation before form building and processing.
  if (!$form_state->has('entity_form_initialized')) {
    $this->init($form_state);
  }

  // Ensure that edit forms have the correct cacheability metadata so they can
  // be cached.
  if (!$this->entity->isNew()) {
    \Drupal::service('renderer')->addCacheableDependency($form, $this->entity);
  }

  // Retrieve the form array using the possibly updated entity in form state.
  $form = $this->form($form, $form_state);

  // Retrieve and add the form actions array.
  $actions = $this->actionsElement($form, $form_state);
  if (!empty($actions)) {
    $form['actions'] = $actions;
  }

  return $form;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Entity!EntityForm.php/function/EntityForm::buildForm/8.1.x