class NodeForm

Same name in other branches
  1. 9 core/modules/node/src/NodeForm.php \Drupal\node\NodeForm
  2. 8.9.x core/modules/node/src/NodeForm.php \Drupal\node\NodeForm
  3. 10 core/modules/node/src/NodeForm.php \Drupal\node\NodeForm

Form handler for the node edit forms.

@internal

Hierarchy

Expanded class hierarchy of NodeForm

1 file declares its use of NodeForm
TestNodeFormOverride.php in core/modules/media_library/tests/modules/media_library_test/src/Form/TestNodeFormOverride.php

File

core/modules/node/src/NodeForm.php, line 20

Namespace

Drupal\node
View source
class NodeForm extends ContentEntityForm {
    
    /**
     * The tempstore factory.
     *
     * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
     */
    protected $tempStoreFactory;
    
    /**
     * The Current User object.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $currentUser;
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * Constructs a NodeForm object.
     *
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository.
     * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
     *   The factory for the temp store object.
     * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
     *   The entity type bundle service.
     * @param \Drupal\Component\Datetime\TimeInterface $time
     *   The time service.
     * @param \Drupal\Core\Session\AccountInterface $current_user
     *   The current user.
     * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
     *   The date formatter service.
     */
    public function __construct(EntityRepositoryInterface $entity_repository, PrivateTempStoreFactory $temp_store_factory, EntityTypeBundleInfoInterface $entity_type_bundle_info, TimeInterface $time, AccountInterface $current_user, DateFormatterInterface $date_formatter) {
        parent::__construct($entity_repository, $entity_type_bundle_info, $time);
        $this->tempStoreFactory = $temp_store_factory;
        $this->currentUser = $current_user;
        $this->dateFormatter = $date_formatter;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity.repository'), $container->get('tempstore.private'), $container->get('entity_type.bundle.info'), $container->get('datetime.time'), $container->get('current_user'), $container->get('date.formatter'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        // Try to restore from temp store, this must be done before calling
        // parent::form().
        $store = $this->tempStoreFactory
            ->get('node_preview');
        // Because of the temp store integration, this is not cacheable.
        // @todo add the correct cache contexts in https://www.drupal.org/project/drupal/issues/3397987
        $form['#cache']['max-age'] = 0;
        // Attempt to load from preview when the uuid is present unless we are
        // rebuilding the form.
        $request_uuid = \Drupal::request()->query
            ->get('uuid');
        if (!$form_state->isRebuilding() && $request_uuid && ($preview = $store->get($request_uuid))) {
            
            /** @var \Drupal\Core\Form\FormStateInterface $preview */
            $form_state->setStorage($preview->getStorage());
            $form_state->setUserInput($preview->getUserInput());
            // Rebuild the form.
            $form_state->setRebuild();
            // The combination of having user input and rebuilding the form means
            // that it will attempt to cache the form state which will fail if it is
            // a GET request.
            $form_state->setRequestMethod('POST');
            $this->entity = $preview->getFormObject()
                ->getEntity();
            $this->entity->in_preview = NULL;
            $form_state->set('has_been_previewed', TRUE);
        }
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = $this->entity;
        if ($this->operation == 'edit') {
            $form['#title'] = $this->t('<em>Edit @type</em> @title', [
                '@type' => node_get_type_label($node),
                '@title' => $node->label(),
            ]);
        }
        // Changed must be sent to the client, for later overwrite error checking.
        $form['changed'] = [
            '#type' => 'hidden',
            '#default_value' => $node->getChangedTime(),
        ];
        $form = parent::form($form, $form_state);
        $form['advanced']['#attributes']['class'][] = 'entity-meta';
        $form['meta'] = [
            '#type' => 'details',
            '#group' => 'advanced',
            '#weight' => -10,
            '#title' => $this->t('Status'),
            '#attributes' => [
                'class' => [
                    'entity-meta__header',
                ],
            ],
            '#tree' => TRUE,
            '#access' => $this->currentUser
                ->hasPermission('administer nodes'),
        ];
        $form['meta']['published'] = [
            '#type' => 'item',
            '#markup' => $node->isPublished() ? $this->t('Published') : $this->t('Not published'),
            '#access' => !$node->isNew(),
            '#wrapper_attributes' => [
                'class' => [
                    'entity-meta__title',
                ],
            ],
        ];
        $form['meta']['changed'] = [
            '#type' => 'item',
            '#title' => $this->t('Last saved'),
            '#markup' => !$node->isNew() ? $this->dateFormatter
                ->format($node->getChangedTime(), 'short') : $this->t('Not saved yet'),
            '#wrapper_attributes' => [
                'class' => [
                    'entity-meta__last-saved',
                ],
            ],
        ];
        $form['meta']['author'] = [
            '#type' => 'item',
            '#title' => $this->t('Author'),
            '#markup' => $node->getOwner()
                ->getAccountName(),
            '#wrapper_attributes' => [
                'class' => [
                    'entity-meta__author',
                ],
            ],
        ];
        $form['status']['#group'] = 'footer';
        // Node author information for administrators.
        $form['author'] = [
            '#type' => 'details',
            '#title' => $this->t('Authoring information'),
            '#group' => 'advanced',
            '#attributes' => [
                'class' => [
                    'node-form-author',
                ],
            ],
            '#attached' => [
                'library' => [
                    'node/drupal.node',
                ],
            ],
            '#weight' => 90,
            '#optional' => TRUE,
        ];
        if (isset($form['uid'])) {
            $form['uid']['#group'] = 'author';
        }
        if (isset($form['created'])) {
            $form['created']['#group'] = 'author';
        }
        // Node options for administrators.
        $form['options'] = [
            '#type' => 'details',
            '#title' => $this->t('Promotion options'),
            '#group' => 'advanced',
            '#attributes' => [
                'class' => [
                    'node-form-options',
                ],
            ],
            '#attached' => [
                'library' => [
                    'node/drupal.node',
                ],
            ],
            '#weight' => 95,
            '#optional' => TRUE,
        ];
        if (isset($form['promote'])) {
            $form['promote']['#group'] = 'options';
        }
        if (isset($form['sticky'])) {
            $form['sticky']['#group'] = 'options';
        }
        $form['#attached']['library'][] = 'node/form';
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        $element = parent::actions($form, $form_state);
        $node = $this->entity;
        $preview_mode = $node->type->entity
            ->getPreviewMode();
        $element['submit']['#access'] = $preview_mode != DRUPAL_REQUIRED || $form_state->get('has_been_previewed');
        $element['preview'] = [
            '#type' => 'submit',
            '#access' => $preview_mode != DRUPAL_DISABLED && ($node->access('create') || $node->access('update')),
            '#value' => $this->t('Preview'),
            '#weight' => 20,
            '#submit' => [
                '::submitForm',
                '::preview',
            ],
        ];
        if (array_key_exists('delete', $element)) {
            $element['delete']['#weight'] = 100;
        }
        return $element;
    }
    
    /**
     * Form submission handler for the 'preview' action.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     */
    public function preview(array $form, FormStateInterface $form_state) {
        $store = $this->tempStoreFactory
            ->get('node_preview');
        $this->entity->in_preview = TRUE;
        $store->set($this->entity
            ->uuid(), $form_state);
        $route_parameters = [
            'node_preview' => $this->entity
                ->uuid(),
            'view_mode_id' => 'full',
        ];
        $options = [];
        $query = $this->getRequest()->query;
        if ($query->has('destination')) {
            $options['query']['destination'] = $query->get('destination');
            $query->remove('destination');
        }
        $form_state->setRedirect('entity.node.preview', $route_parameters, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $node = $this->entity;
        $insert = $node->isNew();
        $node->save();
        $node_link = $node->toLink($this->t('View'))
            ->toString();
        $context = [
            '@type' => $node->getType(),
            '%title' => $node->label(),
            'link' => $node_link,
        ];
        $t_args = [
            '@type' => node_get_type_label($node),
            '%title' => $node->toLink()
                ->toString(),
        ];
        if ($insert) {
            $this->logger('content')
                ->info('@type: added %title.', $context);
            $this->messenger()
                ->addStatus($this->t('@type %title has been created.', $t_args));
        }
        else {
            $this->logger('content')
                ->info('@type: updated %title.', $context);
            $this->messenger()
                ->addStatus($this->t('@type %title has been updated.', $t_args));
        }
        if ($node->id()) {
            $form_state->setValue('nid', $node->id());
            $form_state->set('nid', $node->id());
            if ($node->access('view')) {
                $form_state->setRedirect('entity.node.canonical', [
                    'node' => $node->id(),
                ]);
            }
            else {
                $form_state->setRedirect('<front>');
            }
            // Remove the preview entry from the temp store, if any.
            $store = $this->tempStoreFactory
                ->get('node_preview');
            $store->delete($node->uuid());
        }
        else {
            // In the unlikely case something went wrong on save, the node will be
            // rebuilt and node form redisplayed the same way as in preview.
            $this->messenger()
                ->addError($this->t('The post could not be saved.'));
            $form_state->setRebuild();
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContentEntityForm::$entity protected property The entity being used by this form. Overrides EntityForm::$entity 9
ContentEntityForm::$entityRepository protected property The entity repository service.
ContentEntityForm::$entityTypeBundleInfo protected property The entity type bundle info service.
ContentEntityForm::$time protected property The time service.
ContentEntityForm::addRevisionableFormFields protected function Add revision form fields if the entity enabled the UI.
ContentEntityForm::buildEntity public function Overrides EntityForm::buildEntity 4
ContentEntityForm::copyFormValuesToEntity protected function Overrides EntityForm::copyFormValuesToEntity
ContentEntityForm::flagViolations protected function Flags violations for the current form. 4
ContentEntityForm::getBundleEntity protected function Returns the bundle entity of the entity, or NULL if there is none.
ContentEntityForm::getEditedFieldNames protected function Gets the names of all fields edited in the form. 4
ContentEntityForm::getFormDisplay public function Overrides ContentEntityFormInterface::getFormDisplay
ContentEntityForm::getFormLangcode public function Overrides ContentEntityFormInterface::getFormLangcode
ContentEntityForm::getNewRevisionDefault protected function Should new revisions created on default.
ContentEntityForm::init protected function Initializes the form state and the entity before the first form build. Overrides EntityForm::init 1
ContentEntityForm::initFormLangcodes protected function Initializes form language code values.
ContentEntityForm::isDefaultFormLangcode public function Overrides ContentEntityFormInterface::isDefaultFormLangcode
ContentEntityForm::prepareEntity protected function Overrides EntityForm::prepareEntity 1
ContentEntityForm::setFormDisplay public function Overrides ContentEntityFormInterface::setFormDisplay
ContentEntityForm::showRevisionUi protected function Checks whether the revision form fields should be added to the form.
ContentEntityForm::submitForm public function Overrides EntityForm::submitForm 3
ContentEntityForm::updateChangedTime public function Updates the changed time of the entity.
ContentEntityForm::updateFormLangcode public function Updates the form language to reflect any change to the entity language.
ContentEntityForm::validateForm public function Button-level validation handlers are highly discouraged for entity forms,
as they will prevent entity validation from running. If the entity is going
to be saved during the form submission, this method should be manually
invoked from the button-level…
Overrides FormBase::validateForm 3
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data. 1
EntityForm::buildForm public function Overrides FormInterface::buildForm 13
EntityForm::getBaseFormId public function Overrides BaseFormIdInterface::getBaseFormId 4
EntityForm::getEntity public function Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Overrides FormInterface::getFormId 13
EntityForm::getOperation public function Overrides EntityFormInterface::getOperation
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Overrides EntityFormInterface::setOperation
FormBase::$configFactory protected property The config factory. 2
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. 2
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
NodeForm::$currentUser protected property The Current User object.
NodeForm::$dateFormatter protected property The date formatter service.
NodeForm::$tempStoreFactory protected property The tempstore factory.
NodeForm::actions protected function Overrides EntityForm::actions
NodeForm::create public static function Overrides ContentEntityForm::create
NodeForm::form public function Overrides ContentEntityForm::form
NodeForm::preview public function Form submission handler for the &#039;preview&#039; action.
NodeForm::save public function Overrides EntityForm::save
NodeForm::__construct public function Constructs a NodeForm object. Overrides ContentEntityForm::__construct
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.