class NestedEntityTestForm in Drupal 8

Provides a form for field_test routes.

@internal

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\field_test\Form\NestedEntityTestForm

1 string reference to 'NestedEntityTestForm'

field_test.routing.yml in core/modules/field/tests/modules/field_test/field_test.routing.yml

core/modules/field/tests/modules/field_test/field_test.routing.yml

File

core/modules/field/tests/modules/field_test/src/Form/NestedEntityTestForm.php, line 16

Namespace

Drupal\field_test\Form

class NestedEntityTestForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, EntityInterface $entity_1 = NULL, EntityInterface $entity_2 = NULL) {

    // First entity.
    $form_state
      ->set('entity_1', $entity_1);
    $form_display_1 = EntityFormDisplay::collectRenderDisplay($entity_1, 'default');
    $form_state
      ->set('form_display_1', $form_display_1);
    $form_display_1
      ->buildForm($entity_1, $form, $form_state);

    // Second entity.
    $form_state
      ->set('entity_2', $entity_2);
    $form_display_2 = EntityFormDisplay::collectRenderDisplay($entity_2, 'default');
    $form_state
      ->set('form_display_2', $form_display_2);
    $form['entity_2'] = [
      '#type' => 'details',
      '#title' => t('Second entity'),
      '#tree' => TRUE,
      '#parents' => [
        'entity_2',
      ],
      '#weight' => 50,
      '#attributes' => [
        'class' => [
          'entity-2',
        ],
      ],
    ];
    $form_display_2
      ->buildForm($entity_2, $form['entity_2'], $form_state);
    if ($entity_2 instanceof EntityChangedInterface) {

      // Changed must be sent to the client, for later overwrite error checking.
      // @see \Drupal\Tests\field\Functional\NestedFormTest::testNestedEntityFormEntityLevelValidation()
      $form['entity_2']['changed'] = [
        '#type' => 'hidden',
        '#default_value' => $entity_1
          ->getChangedTime(),
      ];
    }
    $form['save'] = [
      '#type' => 'submit',
      '#value' => t('Save'),
      '#weight' => 100,
    ];
    return $form;
  }

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

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display_1 */
    $form_display_1 = $form_state
      ->get('form_display_1');
    $form_display_1
      ->extractFormValues($entity_1, $form, $form_state);
    $form_display_1
      ->validateFormValues($entity_1, $form, $form_state);
    $entity_2 = $form_state
      ->get('entity_2');

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display_2 */
    $form_display_2 = $form_state
      ->get('form_display_2');
    $extracted = $form_display_2
      ->extractFormValues($entity_2, $form['entity_2'], $form_state);

    // Extract the values of fields that are not rendered through widgets, by
    // simply copying from top-level form values. This leaves the fields that
    // are not being edited within this form untouched.
    // @see \Drupal\Tests\field\Functional\NestedFormTest::testNestedEntityFormEntityLevelValidation()
    foreach ($form_state
      ->getValues()['entity_2'] as $name => $values) {
      if ($entity_2
        ->hasField($name) && !isset($extracted[$name])) {
        $entity_2
          ->set($name, $values);
      }
    }
    $form_display_2
      ->validateFormValues($entity_2, $form['entity_2'], $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\Core\Entity\EntityInterface $entity_1 */
    $entity_1 = $form_state
      ->get('entity_1');
    $entity_1
      ->save();

    /** @var \Drupal\Core\Entity\EntityInterface $entity_2 */
    $entity_2 = $form_state
      ->get('entity_2');
    $entity_2
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('test_entities @id_1 and @id_2 have been updated.', [
      '@id_1' => $entity_1
        ->id(),
      '@id_2' => $entity_2
        ->id(),
    ]));
  }

}

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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
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.
NestedEntityTestForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
NestedEntityTestForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
NestedEntityTestForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
NestedEntityTestForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.