class EntityDisplayModeListBuilder

Same name in other branches
  1. 9 core/modules/field_ui/src/EntityDisplayModeListBuilder.php \Drupal\field_ui\EntityDisplayModeListBuilder
  2. 8.9.x core/modules/field_ui/src/EntityDisplayModeListBuilder.php \Drupal\field_ui\EntityDisplayModeListBuilder
  3. 10 core/modules/field_ui/src/EntityDisplayModeListBuilder.php \Drupal\field_ui\EntityDisplayModeListBuilder

Defines a class to build a listing of view mode entities.

Hierarchy

Expanded class hierarchy of EntityDisplayModeListBuilder

See also

\Drupal\Core\Entity\Entity\EntityViewMode

File

core/modules/field_ui/src/EntityDisplayModeListBuilder.php, line 19

Namespace

Drupal\field_ui
View source
class EntityDisplayModeListBuilder extends ConfigEntityListBuilder {
    
    /**
     * All entity types.
     *
     * @var \Drupal\Core\Entity\EntityTypeInterface[]
     */
    protected $entityTypes;
    
    /**
     * Constructs a new EntityDisplayModeListBuilder object.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The entity storage class.
     * @param \Drupal\Core\Entity\EntityTypeInterface[] $entity_types
     *   List of all entity types.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, array $entity_types) {
        parent::__construct($entity_type, $storage);
        // Override the default limit (50) in order to display all view modes.
        $this->limit = FALSE;
        $this->entityTypes = $entity_types;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        $entity_type_manager = $container->get('entity_type.manager');
        return new static($entity_type, $entity_type_manager->getStorage($entity_type->id()), $entity_type_manager->getDefinitions());
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header['label'] = $this->t('Name');
        $header['description'] = $this->t('Description');
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row['label'] = $entity->label();
        $row['description'] = $entity->getDescription();
        return $row + parent::buildRow($entity);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOperations(EntityInterface $entity) {
        // Make the edit form render in a dialog, like the add form.
        // The edit form also contains an option to delete the view mode, which
        // also spawns a dialog. Rather than have nested dialogs, we allow the
        // existing dialog to be replaced, so users will be shown the list again
        // if they cancel deleting the view mode.
        $operations = parent::getOperations($entity);
        if (isset($operations['edit'])) {
            $operations['edit'] = NestedArray::mergeDeepArray([
                [
                    'attributes' => [
                        'class' => [
                            'button',
                            'use-ajax',
                        ],
                        'data-dialog-type' => 'modal',
                        'data-dialog-options' => Json::encode([
                            'width' => '880',
                        ]),
                    ],
                ],
                $operations['edit'],
            ]);
        }
        return $operations;
    }
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $entities = [];
        foreach (parent::load() as $entity) {
            $entities[$entity->getTargetType()][] = $entity;
        }
        return $entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        $build = [];
        foreach ($this->load() as $entity_type => $entities) {
            if (!isset($this->entityTypes[$entity_type])) {
                continue;
            }
            // Filter entities.
            if (!$this->isValidEntity($entity_type)) {
                continue;
            }
            $table = [
                '#prefix' => '<h2>' . $this->entityTypes[$entity_type]
                    ->getLabel() . '</h2>',
                '#type' => 'table',
                '#header' => $this->buildHeader(),
                '#rows' => [],
                '#attributes' => [
                    'class' => [
                        'display-mode-table',
                    ],
                ],
            ];
            foreach ($entities as $entity) {
                if ($row = $this->buildRow($entity)) {
                    $table['#rows'][$entity->id()] = $row;
                }
            }
            // Move content at the top.
            if ($entity_type == 'node') {
                $table['#weight'] = -10;
            }
            $short_type = str_replace([
                'entity_',
                '_mode',
            ], '', $this->entityTypeId);
            $table['#rows']['_add_new'][] = [
                'data' => [
                    '#type' => 'link',
                    '#url' => Url::fromRoute($short_type == 'view' ? 'entity.entity_view_mode.add_form' : 'entity.entity_form_mode.add_form', [
                        'entity_type_id' => $entity_type,
                    ]),
                    '#title' => $this->t('Add %label for @entity-type', [
                        '@entity-type' => $this->entityTypes[$entity_type]
                            ->getLabel(),
                        '%label' => $this->entityType
                            ->getSingularLabel(),
                    ]),
                    '#button_type' => 'primary',
                    '#attributes' => [
                        'class' => [
                            'button',
                            'use-ajax',
                            'button--small',
                        ],
                        'data-dialog-type' => 'modal',
                        'data-dialog-options' => Json::encode([
                            'width' => '880',
                        ]),
                    ],
                    '#attached' => [
                        'library' => [
                            'core/drupal.dialog.ajax',
                            'field_ui/drupal.field_ui_table',
                        ],
                    ],
                ],
                'colspan' => count($table['#header']),
            ];
            $build[$entity_type] = $table;
        }
        return $build;
    }
    
    /**
     * Filters entities based on their view builder handlers.
     *
     * @param $entity_type
     *   The entity type of the entity that needs to be validated.
     *
     * @return bool
     *   TRUE if the entity has the correct view builder handler, FALSE if the
     *   entity doesn't have the correct view builder handler.
     */
    protected function isValidEntity($entity_type) {
        return $this->entityTypes[$entity_type]
            ->get('field_ui_base_route') && $this->entityTypes[$entity_type]
            ->hasViewBuilderClass();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getDefaultOperations public function Gets this list&#039;s default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityDisplayModeListBuilder::$entityTypes protected property All entity types.
EntityDisplayModeListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
EntityDisplayModeListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
EntityDisplayModeListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
EntityDisplayModeListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
EntityDisplayModeListBuilder::isValidEntity protected function Filters entities based on their view builder handlers. 1
EntityDisplayModeListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
EntityDisplayModeListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
EntityDisplayModeListBuilder::__construct public function Constructs a new EntityDisplayModeListBuilder object. Overrides EntityListBuilder::__construct
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.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::SORT_KEY protected constant The entity key to sort the list by. 1
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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.

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