class NodeListBuilder

Same name in other branches
  1. 9 core/modules/node/src/NodeListBuilder.php \Drupal\node\NodeListBuilder
  2. 8.9.x core/modules/node/src/NodeListBuilder.php \Drupal\node\NodeListBuilder
  3. 11.x core/modules/node/src/NodeListBuilder.php \Drupal\node\NodeListBuilder

Defines a class to build a listing of node entities.

Hierarchy

Expanded class hierarchy of NodeListBuilder

See also

\Drupal\node\Entity\Node

1 file declares its use of NodeListBuilder
ModeratedNodeListBuilder.php in core/modules/content_moderation/src/ModeratedNodeListBuilder.php

File

core/modules/node/src/NodeListBuilder.php, line 18

Namespace

Drupal\node
View source
class NodeListBuilder extends EntityListBuilder {
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * Constructs a new NodeListBuilder 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\Datetime\DateFormatterInterface $date_formatter
     *   The date formatter service.
     * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
     *   The redirect destination service.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, DateFormatterInterface $date_formatter, RedirectDestinationInterface $redirect_destination) {
        parent::__construct($entity_type, $storage);
        $this->dateFormatter = $date_formatter;
        $this->redirectDestination = $redirect_destination;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager')
            ->getStorage($entity_type->id()), $container->get('date.formatter'), $container->get('redirect.destination'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        // Enable language column and filter if multiple languages are added.
        $header = [
            'title' => $this->t('Title'),
            'type' => [
                'data' => $this->t('Content type'),
                'class' => [
                    RESPONSIVE_PRIORITY_MEDIUM,
                ],
            ],
            'author' => [
                'data' => $this->t('Author'),
                'class' => [
                    RESPONSIVE_PRIORITY_LOW,
                ],
            ],
            'status' => $this->t('Status'),
            'changed' => [
                'data' => $this->t('Updated'),
                'class' => [
                    RESPONSIVE_PRIORITY_LOW,
                ],
            ],
        ];
        if (\Drupal::languageManager()->isMultilingual()) {
            $header['language_name'] = [
                'data' => $this->t('Language'),
                'class' => [
                    RESPONSIVE_PRIORITY_LOW,
                ],
            ];
        }
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        
        /** @var \Drupal\node\NodeInterface $entity */
        $mark = [
            '#theme' => 'mark',
            '#status' => node_mark($entity->id(), $entity->getChangedTime()),
        ];
        $row['title']['data'] = [
            '#type' => 'link',
            '#title' => $entity->label(),
            '#suffix' => ' ' . \Drupal::service('renderer')->render($mark),
            '#url' => $entity->toUrl(),
        ];
        $row['type'] = node_get_type_label($entity);
        $row['author']['data'] = [
            '#theme' => 'username',
            '#account' => $entity->getOwner(),
        ];
        $row['status'] = $entity->isPublished() ? $this->t('published') : $this->t('not published');
        $row['changed'] = $this->dateFormatter
            ->format($entity->getChangedTime(), 'short');
        $language_manager = \Drupal::languageManager();
        if ($language_manager->isMultilingual()) {
            $row['language_name'] = $language_manager->getLanguageName($entity->language()
                ->getId());
        }
        $row['operations']['data'] = $this->buildOperations($entity);
        return $row + parent::buildRow($entity);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
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.
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::$storage protected property The entity storage class. 2
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::getDefaultOperations protected function Gets this list's default operations. 3
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 5
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 3
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage 1
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 17
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
NodeListBuilder::$dateFormatter protected property The date formatter service.
NodeListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader 1
NodeListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow 1
NodeListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance 1
NodeListBuilder::__construct public function Constructs a new NodeListBuilder object. Overrides EntityListBuilder::__construct 1
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 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.