class NodePreviewController

Same name in other branches
  1. 9 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. 11.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

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

Namespace

Drupal\node\Controller
View source
class NodePreviewController extends EntityViewController {
    
    /**
     * The entity repository service.
     *
     * @var \Drupal\Core\Entity\EntityRepositoryInterface
     */
    protected $entityRepository;
    
    /**
     * Creates an NodeViewController object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer service.
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer, EntityRepositoryInterface $entity_repository = NULL) {
        parent::__construct($entity_type_manager, $renderer);
        if (!$entity_repository) {
            @trigger_error('The entity.repository service must be passed to NodePreviewController::__construct(), it is required before Drupal 9.0.0. See https://www.drupal.org/node/2549139.', E_USER_DEPRECATED);
            $entity_repository = \Drupal::service('entity.repository');
        }
        $this->entityRepository = $entity_repository;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager'), $container->get('renderer'), $container->get('entity.repository'));
    }
    
    /**
     * {@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';
        // 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.
     */
    public function title(EntityInterface $node_preview) {
        return $this->entityRepository
            ->getTranslationFromContext($node_preview)
            ->label();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityViewController::$deprecatedProperties protected property
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
EntityViewController::viewRevision public function Provides a page to render a single entity revision.
NodePreviewController::$entityRepository protected property The entity repository service.
NodePreviewController::create public static function Instantiates a new instance of this class. Overrides EntityViewController::create
NodePreviewController::title 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 an NodeViewController 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.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

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