class PreviewFactory in View Modes Display 8.2

Class PreviewFactory.

@package Drupal\view_modes_display\Service

Hierarchy

• class \Drupal\view_modes_display\Service\PreviewFactory

1 file declares its use of PreviewFactory

PreviewController.php in src/Controller/PreviewController.php

1 string reference to 'PreviewFactory'

view_modes_display.services.yml in ./view_modes_display.services.yml

view_modes_display.services.yml

1 service uses PreviewFactory

view_modes_display.preview_factory in ./view_modes_display.services.yml

Drupal\view_modes_display\Service\PreviewFactory

File

src/Service/PreviewFactory.php, line 15

Namespace

Drupal\view_modes_display\Service

class PreviewFactory {

  /**
   * ConfigFactory.
   *
   * @var Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * EntityTypeManager.
   *
   * @var Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

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

  /**
   * DefaultController constructor.
   *
   * @param Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   Config Factory.
   * @param Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity Type Manager.
   * @param Drupal\Core\Entity\EntityDisplayRepositoryInterface $entityDisplayRepository
   *   Entity Display Repository.
   */
  public function __construct(ConfigFactoryInterface $configFactory, EntityTypeManagerInterface $entityTypeManager, EntityDisplayRepositoryInterface $entityDisplayRepository) {
    $this->configFactory = $configFactory;
    $this->entityTypeManager = $entityTypeManager;
    $this->entityDisplayRepository = $entityDisplayRepository;
  }

  /**
   * Preview entity view modes.
   *
   * @param \Drupal\Core\ContentEntityInterface $entity
   *   Content Entity Interface.
   *
   * @return array
   *   Preview content of entity view modes.
   */
  public function preview(ContentEntityInterface $entity) {
    $entityTypeId = $entity
      ->getEntityType()
      ->get('id');
    $entityDisplays = $this
      ->getEntityDisplays($entityTypeId, $entity
      ->bundle());
    $enabledDisplayModes = $this
      ->getEnabledDisplayModes($entityDisplays);
    $viewModes = $this->entityDisplayRepository
      ->getViewModes($entityTypeId);
    $renderArray = [];
    foreach ($viewModes as $viewMode => $viewModeData) {
      if (FALSE == in_array($viewMode, $enabledDisplayModes)) {
        continue;
      }
      $markup = $this
        ->buildMarkup($entity, $viewMode);
      $renderArray[] = [
        '#prefix' => '<div class="view-mode-list-item view-mode-list-item-' . $viewMode . '"><div class="view-mode-list-item-label">' . $viewModeData['label'] . '</div><div class="view-mode-list-item-content">',
        '#markup' => render($markup),
        '#suffix' => '</div></div>',
      ];
    }
    return $renderArray;
  }

  /**
   * Returns array of enabled displays.
   *
   * @param array $displays
   *   Entity displays.
   *
   * @return array
   *   Array of enabled display modes.
   */
  public function getEnabledDisplayModes(array $displays) {
    $enabledDisplayModes = [];
    foreach ($displays as $display) {
      if ($display
        ->status()) {
        $enabledDisplayModes[] = $display
          ->get('mode');
      }
    }
    if (FALSE == array_key_exists('full', $enabledDisplayModes)) {
      $enabledDisplayModes[] = 'full';
    }
    return $enabledDisplayModes;
  }

  /**
   * Returns all display for an entity.
   *
   * @param string $entityTypeId
   *   Entity id.
   * @param string $entityBundle
   *   Entity bundle.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   Array of entity displays.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getEntityDisplays($entityTypeId, $entityBundle) {
    $configPrefix = 'core.entity_view_display';
    $prefix = $configPrefix . '.' . $entityTypeId . '.' . $entityBundle . '.';
    $configKeys = $this->configFactory
      ->listAll($prefix);
    $displayKeys = [];
    foreach ($configKeys as $configKey) {
      $displayKeys[] = str_replace($configPrefix . '.', '', $configKey);
    }
    return $this->entityTypeManager
      ->getStorage('entity_view_display')
      ->loadMultiple($displayKeys);
  }

  /**
   * Build markup required to render the entity in the desired view mode.
   *
   * @param Drupal\Core\Entity\ContentEntityInterface $entity
   *   Entity class.
   * @param string $viewMode
   *   Entity view mode.
   *
   * @return array
   *   Render array for the given entity.
   *
   * @todo Handle block requirements better.
   */
  public function buildMarkup(ContentEntityInterface $entity, $viewMode) {
    $entityTypeId = $entity
      ->getEntityType()
      ->get('id');
    $viewBuilder = $this->entityTypeManager
      ->getViewBuilder($entityTypeId);
    if ('block_content' == $entityTypeId) {
      $blockManager = \Drupal::service('plugin.manager.block');
      $blockInstance = $blockManager
        ->createInstance('block_content:' . $entity
        ->uuid(), [
        'view_mode' => $viewMode,
      ]);
      return [
        // @todo Should be in BlockBase, wait https://www.drupal.org/node/2931040.
        '#theme' => 'block',
        '#configuration' => $blockInstance
          ->getConfiguration(),
        '#plugin_id' => $blockInstance
          ->getPluginId(),
        '#base_plugin_id' => $blockInstance
          ->getBaseId(),
        '#derivative_plugin_id' => $blockInstance
          ->getDerivativeId(),
        'content' => $blockInstance
          ->build(),
      ];
    }
    return $viewBuilder
      ->view($entity, $viewMode);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PreviewFactory::$configFactory	protected	property	ConfigFactory.
PreviewFactory::$entityDisplayRepository	protected	property	EntityDisplayRepository.
PreviewFactory::$entityTypeManager	protected	property	EntityTypeManager.
PreviewFactory::buildMarkup	public	function	Build markup required to render the entity in the desired view mode.
PreviewFactory::getEnabledDisplayModes	public	function	Returns array of enabled displays.
PreviewFactory::getEntityDisplays	public	function	Returns all display for an entity.
PreviewFactory::preview	public	function	Preview entity view modes.
PreviewFactory::__construct	public	function	DefaultController constructor.