class NodePreviewController

Same name and namespace in other branches
  1. 11.x core/modules/node/src/Controller/NodePreviewController.php \Drupal\node\Controller\NodePreviewController
  2. 10 core/modules/node/src/Controller/NodePreviewController.php \Drupal\node\Controller\NodePreviewController
  3. 9 core/modules/node/src/Controller/NodePreviewController.php \Drupal\node\Controller\NodePreviewController
  4. 8.9.x core/modules/node/src/Controller/NodePreviewController.php \Drupal\node\Controller\NodePreviewController

Defines a controller to render a single node in preview.

Hierarchy

Expanded class hierarchy of NodePreviewController

File

View on git.drupalcode.org

core/modules/node/src/Controller/NodePreviewController.php, line 17

Namespace

Drupal\node\Controller
View source 
class NodePreviewController extends EntityViewController {
  
  /**
   * Creates a NodePreviewController object.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer, protected readonly EntityRepositoryInterface $entityRepository, protected ?FormBuilderInterface $formBuilder = NULL) {
    parent::__construct($entity_type_manager, $renderer);
    if ($this->formBuilder === NULL) {
      @trigger_error('Calling ' . __CLASS__ . ' constructor without the $formBuilder argument is deprecated in drupal:11.4.0 and it will be required in drupal:12.0.0. See https://www.drupal.org/project/drupal/issues/3339905', E_USER_DEPRECATED);
      $this->formBuilder = \Drupal::service('form_builder');
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container->get('entity_type.manager'), $container->get('renderer'), $container->get('entity.repository'), $container->get('form_builder'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function view(EntityInterface $node_preview, $view_mode_id = 'full', $langcode = NULL) {
    $node_preview->preview_view_mode = $view_mode_id;
    $build = parent::view($node_preview, $view_mode_id);
    $build['#attached']['library'][] = 'node/drupal.node.preview';
    $build['#attached']['page_top']['node_preview'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'node-preview-container',
          'container-inline',
        ],
      ],
      'view_mode' => $this->formBuilder
        ->getForm(NodePreviewForm::class, $node_preview),
    ];
    // Don't render cache previews.
    unset($build['#cache']);
    return $build;
  }
  
  /**
   * The _title_callback for the page that renders a single node in preview.
   *
   * @param \Drupal\Core\Entity\EntityInterface $node_preview
   *   The current node.
   *
   * @return string
   *   The page title.
   *
   * @deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. There is no
   * replacement.
   * @see https://www.drupal.org/project/drupal/issues/3024386
   */
  public function title(EntityInterface $node_preview) {
    @trigger_error(__METHOD__ . ' is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. There is no replacement. See https://www.drupal.org/project/drupal/issues/3024386', E_USER_DEPRECATED);
    return $this->entityRepository
      ->getTranslationFromContext($node_preview)
      ->label();
  }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title
EntityViewController::$entityTypeManager protected property The entity type manager.
EntityViewController::$renderer protected property The renderer service.
EntityViewController::buildTitle public function Pre-render callback to build the page title.
EntityViewController::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
NodePreviewController::create public static function Instantiates a new instance of this class. Overrides EntityViewController::create
NodePreviewController::title Deprecated public function The _title_callback for the page that renders a single node in preview.
NodePreviewController::view public function Provides a page to render a single entity. Overrides EntityViewController::view
NodePreviewController::__construct public function Creates a NodePreviewController object. Overrides EntityViewController::__construct
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.

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