NodeListBuilder.php

Same filename in other branches
  1. 8.9.x core/modules/node/src/NodeListBuilder.php
  2. 10 core/modules/node/src/NodeListBuilder.php
  3. 11.x core/modules/node/src/NodeListBuilder.php

Namespace

Drupal\node

File

core/modules/node/src/NodeListBuilder.php

View source
<?php

namespace Drupal\node;

use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityListBuilder;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Routing\RedirectDestinationInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines a class to build a listing of node entities.
 *
 * @see \Drupal\node\Entity\Node
 */
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',
            '#mark_type' => 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);
    }

}

Classes

Title Deprecated Summary
NodeListBuilder Defines a class to build a listing of node entities.

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