You are here

Home » API reference » Configuration Split 2.0.x » ConfigSplitEntityViewBuilder.php

class ConfigSplitEntityViewBuilder in Configuration Split 2.0.x

Same name and namespace in other branches
  1. 8 src/ConfigSplitEntityViewBuilder.php \Drupal\config_split\ConfigSplitEntityViewBuilder

EntityViewBuilder for Config Split entities.

Hierarchy

Expanded class hierarchy of ConfigSplitEntityViewBuilder

File

src/ConfigSplitEntityViewBuilder.php, line 13

Namespace

Drupal\config_split
View source 
class ConfigSplitEntityViewBuilder extends EntityViewBuilder {

  /**
   * The split manager.
   *
   * @var \Drupal\config_split\ConfigSplitManager
   */
  protected $splitManager;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    $handler = parent::createInstance($container, $entity_type);
    $handler->splitManager = $container
      ->get('config_split.manager');
    return $handler;
  }

  /**
   * {@inheritdoc}
   */
  public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) {

    /** @var \Drupal\config_split\Entity\ConfigSplitEntityInterface[] $entities */
    $build = [];

    /**
     * @var string $entity_id
     * @var \Drupal\config_split\Entity\ConfigSplitEntity $entity
     */
    foreach ($entities as $entity_id => $entity) {
      $config = $this->splitManager
        ->getSplitConfig($entity
        ->getConfigDependencyName());

      // @todo make this prettier.
      $build[$entity_id] = [
        '#cache' => [
          'tags' => $entity
            ->getCacheTags(),
        ],
      ];
      try {
        $storage = $this->splitManager
          ->singleExportPreview($config);
        $build[$entity_id]['preview'] = [
          '#type' => 'container',
          'title' => [
            '#type' => 'html_tag',
            '#tag' => 'h3',
            '#value' => $this
              ->t('Preview'),
          ],
          'items' => [
            '#theme' => 'item_list',
            '#items' => $this
              ->listStorageContents($storage),
            '#list_type' => 'ul',
          ],
        ];
      } catch (\Exception $exception) {
        $build[$entity_id]['preview'] = [
          '#markup' => $this
            ->t('Can not display preview of %split', [
            '%split' => $entity
              ->label(),
          ]),
        ];
      }
      try {
        $storage = $this->splitManager
          ->singleExportTarget($config);
        $build[$entity_id]['exported'] = [
          '#type' => 'container',
          'title' => [
            '#type' => 'html_tag',
            '#tag' => 'h3',
            '#value' => $this
              ->t('Exported'),
          ],
          'items' => [
            '#theme' => 'item_list',
            '#items' => $this
              ->listStorageContents($storage),
            '#list_type' => 'ul',
          ],
        ];
      } catch (\Exception $exception) {
        $build[$entity_id]['exported'] = [
          '#markup' => $this
            ->t('Can not display export storage of %split', [
            '%split' => $entity
              ->label(),
          ]),
        ];
      }
    }
    return $build;
  }

  /**
   * List the contents of a storage.
   *
   * @param \Drupal\Core\Config\StorageInterface $storage
   *   The storage.
   *
   * @return array
   *   the contents.
   */
  protected function listStorageContents(StorageInterface $storage) : array {
    $list = $storage
      ->createCollection(StorageInterface::DEFAULT_COLLECTION)
      ->listAll();
    foreach ($storage
      ->getAllCollectionNames() as $collection) {
      foreach ($storage
        ->createCollection($collection)
        ->listAll() as $name) {
        $list[] = $collection . ':' . $name;
      }
    }
    return $list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigSplitEntityViewBuilder::$splitManager protected property The split manager.
ConfigSplitEntityViewBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityViewBuilder::createInstance
ConfigSplitEntityViewBuilder::listStorageContents protected function List the contents of a storage.
ConfigSplitEntityViewBuilder::viewMultiple public function Builds the render array for the provided entities. Overrides EntityViewBuilder::viewMultiple
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityViewBuilder::$cacheBin protected property The cache bin used to store the render cache.
EntityViewBuilder::$entityDisplayRepository protected property The entity display repository.
EntityViewBuilder::$entityRepository protected property The entity repository service.
EntityViewBuilder::$entityType protected property Information about the entity type.
EntityViewBuilder::$entityTypeId protected property The type of entities for which this view builder is instantiated.
EntityViewBuilder::$languageManager protected property The language manager.
EntityViewBuilder::$singleFieldDisplays protected property The EntityViewDisplay objects created for individual field rendering.
EntityViewBuilder::$themeRegistry protected property The theme registry.
EntityViewBuilder::addContextualLinks protected function Add contextual links.
EntityViewBuilder::alterBuild protected function Specific per-entity building. 1
EntityViewBuilder::build public function Builds an entity's view; augments entity defaults.
EntityViewBuilder::buildComponents public function Builds the component fields and properties of a set of entities. Overrides EntityViewBuilderInterface::buildComponents 7
EntityViewBuilder::buildMultiple public function Builds multiple entities' views; augments entity defaults.
EntityViewBuilder::getBuildDefaults protected function Provides entity-specific defaults to the build process. 4
EntityViewBuilder::getCacheTags public function The cache tag associated with this entity view builder. Overrides EntityViewBuilderInterface::getCacheTags
EntityViewBuilder::getSingleFieldDisplay protected function Gets an EntityViewDisplay for rendering an individual field.
EntityViewBuilder::isViewModeCacheable protected function Determines whether the view mode is cacheable.
EntityViewBuilder::resetCache public function Resets the entity render cache. Overrides EntityViewBuilderInterface::resetCache
EntityViewBuilder::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 2
EntityViewBuilder::view public function Builds the render array for the provided entity. Overrides EntityViewBuilderInterface::view 4
EntityViewBuilder::viewField public function Builds a renderable array for the value of a single field in an entity. Overrides EntityViewBuilderInterface::viewField
EntityViewBuilder::viewFieldItem public function Builds a renderable array for a single field item. Overrides EntityViewBuilderInterface::viewFieldItem
EntityViewBuilder::__construct public function Constructs a new EntityViewBuilder. 2
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
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.