You are here

Home » API reference » View Modes Display 8.2 » PreviewController.php

class PreviewController in View Modes Display 8.2

Class DefaultController.

@package Drupal\view_modes_display\Controller

Hierarchy

Expanded class hierarchy of PreviewController

File

src/Controller/PreviewController.php, line 22

Namespace

Drupal\view_modes_display\Controller
View source 
class PreviewController extends ControllerBase {

  /**
   * ConfigFactory.
   *
   * @var \Drupal\view_modes_display\Service\PreviewFactory
   */
  protected $previewFactory;

  /**
   * EntityDisplayRepository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * DefaultController constructor.
   *
   * @param \Drupal\view_modes_display\Service\PreviewFactory $previewFactory
   *   Preview Factory.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entityDisplayRepository
   *   Entity Display Repository.
   */
  public function __construct(PreviewFactory $previewFactory, EntityDisplayRepositoryInterface $entityDisplayRepository) {
    $this->previewFactory = $previewFactory;
    $this->entityDisplayRepository = $entityDisplayRepository;
  }

  /**
   * {@inheritdoc}
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   Container.
   *
   * @return \Drupal\Core\Controller\ControllerBase
   *   ControllerBase with injected services.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('view_modes_display.preview_factory'), $container
      ->get('entity_display.repository'));
  }

  /**
   * Returns preview for entity - dedicated view mode or all of them.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   Route match.
   *
   * @param string $entity_type
   *
   * @return array
   *   Preview render array.
   */
  public function previewEntity(RouteMatchInterface $route_match, $entity_type) {

    /** @var EntityInterface $entity */
    $entity = $route_match
      ->getParameter($entity_type);
    $view_mode = $route_match
      ->getParameter('view_mode');
    $view_modes = $this->entityDisplayRepository
      ->getViewModes($entity
      ->getEntityTypeId());
    $renderArray = [];

    // Special view mode placeholder to fetch all. Default in the route
    // definition.
    if ($view_mode == 'all') {
      $renderArray = $this->previewFactory
        ->preview($entity);
    }
    else {
      $markup = $this->previewFactory
        ->buildMarkup($entity, $view_mode);
      $renderArray[] = [
        '#prefix' => '<div class="view-mode-list-item view-mode-list-item-' . $view_mode . '"><div class="view-mode-list-item-label">' . $view_modes[$view_mode]['label'] . '</div><div class="view-mode-list-item-content">',
        '#markup' => render($markup),
        '#suffix' => '</div></div>',
      ];
    }
    return $renderArray;
  }

  /**
   * Provides a link list with all available - dedicated - view mode previews.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   * @param string $entity_type
   *
   * @return array
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  public function previewList(RouteMatchInterface $route_match, $entity_type) {
    $content = [];
    $links = [];
    $view_modes = $this->entityDisplayRepository
      ->getViewModes($entity_type);

    /** @var EntityInterface $entity */
    $entity = $route_match
      ->getParameter($entity_type);
    $entityDisplays = $this->previewFactory
      ->getEntityDisplays($entity_type, $entity
      ->bundle());
    foreach ($this->previewFactory
      ->getEnabledDisplayModes($entityDisplays) as $display) {
      $label = ucfirst($display);
      if (isset($view_modes[$display]['label'])) {
        $label = $view_modes[$display]['label'];
      }
      $url = $entity
        ->toUrl('vmd-preview-list');
      $url = $url
        ->setRouteParameter('view_mode', $display);
      $links[] = [
        '#type' => 'link',
        '#url' => $url,
        '#title' => t('Preview %label', [
          '%label' => $label,
        ]),
      ];
    }
    $content['preview_links'] = [
      '#theme' => 'item_list',
      '#items' => $links,
      '#title' => t('Available ViewMode Previews:'),
    ];
    return $content;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
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.
PreviewController::$entityDisplayRepository protected property EntityDisplayRepository.
PreviewController::$previewFactory protected property ConfigFactory.
PreviewController::create public static function Overrides ControllerBase::create
PreviewController::previewEntity public function Returns preview for entity - dedicated view mode or all of them.
PreviewController::previewList public function Provides a link list with all available - dedicated - view mode previews.
PreviewController::__construct public function DefaultController constructor.
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.