class NodePreviewForm

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

Contains a form for switching the view mode of a node during preview.

@internal

Hierarchy

Expanded class hierarchy of NodePreviewForm

1 file declares its use of NodePreviewForm
node.module in core/modules/node/node.module
The core module that allows content to be submitted to the site.

File

core/modules/node/src/Form/NodePreviewForm.php, line 18

Namespace

Drupal\node\Form
View source
class NodePreviewForm extends FormBase {
    
    /**
     * The entity display repository.
     *
     * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
     */
    protected $entityDisplayRepository;
    
    /**
     * The config factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_display.repository'), $container->get('config.factory'));
    }
    
    /**
     * Constructs a new NodePreviewForm.
     *
     * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
     *   The entity display repository.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The configuration factory.
     */
    public function __construct(EntityDisplayRepositoryInterface $entity_display_repository, ConfigFactoryInterface $config_factory) {
        $this->entityDisplayRepository = $entity_display_repository;
        $this->configFactory = $config_factory;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'node_preview_form_select';
    }
    
    /**
     * Form constructor.
     *
     * @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.
     * @param \Drupal\Core\Entity\EntityInterface $node
     *   The node being previews
     *
     * @return array
     *   The form structure.
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?EntityInterface $node = NULL) {
        $view_mode = $node->preview_view_mode;
        $query_options = [
            'query' => [
                'uuid' => $node->uuid(),
            ],
        ];
        $query = $this->getRequest()->query;
        if ($query->has('destination')) {
            $query_options['query']['destination'] = $query->get('destination');
        }
        $form['backlink'] = [
            '#type' => 'link',
            '#title' => $this->t('Back to content editing'),
            '#url' => $node->isNew() ? Url::fromRoute('node.add', [
                'node_type' => $node->bundle(),
            ]) : $node->toUrl('edit-form'),
            '#options' => [
                'attributes' => [
                    'class' => [
                        'node-preview-backlink',
                    ],
                ],
            ] + $query_options,
        ];
        // Always show full as an option, even if the display is not enabled.
        $view_mode_options = [
            'full' => $this->t('Full'),
        ] + $this->entityDisplayRepository
            ->getViewModeOptionsByBundle('node', $node->bundle());
        // Unset view modes that are not used in the front end.
        unset($view_mode_options['default']);
        unset($view_mode_options['rss']);
        unset($view_mode_options['search_index']);
        $form['uuid'] = [
            '#type' => 'value',
            '#value' => $node->uuid(),
        ];
        $form['view_mode'] = [
            '#type' => 'select',
            '#title' => $this->t('View mode'),
            '#options' => $view_mode_options,
            '#default_value' => $view_mode,
            '#attributes' => [
                'data-drupal-autosubmit' => TRUE,
            ],
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Switch'),
            '#attributes' => [
                'class' => [
                    'js-hide',
                ],
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $route_parameters = [
            'node_preview' => $form_state->getValue('uuid'),
            'view_mode_id' => $form_state->getValue('view_mode'),
        ];
        $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);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 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.
FormBase::validateForm public function Overrides FormInterface::validateForm 57
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.
NodePreviewForm::$configFactory protected property The config factory. Overrides FormBase::$configFactory
NodePreviewForm::$entityDisplayRepository protected property The entity display repository.
NodePreviewForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
NodePreviewForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
NodePreviewForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
NodePreviewForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
NodePreviewForm::__construct public function Constructs a new NodePreviewForm.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 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.