class NodeListBuilder in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/node/src/NodeListBuilder.php \Drupal\node\NodeListBuilder

Defines a class to build a listing of node entities.

View source

class NodeListBuilder extends EntityListBuilder {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The redirect destination service.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  protected $redirectDestination;

  /**
   * 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.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 = array(
      'title' => $this
        ->t('Title'),
      'type' => array(
        'data' => $this
          ->t('Content type'),
        'class' => array(
          RESPONSIVE_PRIORITY_MEDIUM,
        ),
      ),
      'author' => array(
        'data' => $this
          ->t('Author'),
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      ),
      'status' => $this
        ->t('Status'),
      'changed' => array(
        'data' => $this
          ->t('Updated'),
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      ),
    );
    if (\Drupal::languageManager()
      ->isMultilingual()) {
      $header['language_name'] = array(
        'data' => $this
          ->t('Language'),
        'class' => array(
          RESPONSIVE_PRIORITY_LOW,
        ),
      );
    }
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\node\NodeInterface $entity */
    $mark = array(
      '#theme' => 'mark',
      '#mark_type' => node_mark($entity
        ->id(), $entity
        ->getChangedTime()),
    );
    $langcode = $entity
      ->language()
      ->getId();
    $uri = $entity
      ->urlInfo();
    $options = $uri
      ->getOptions();
    $options += $langcode != LanguageInterface::LANGCODE_NOT_SPECIFIED && isset($languages[$langcode]) ? array(
      'language' => $languages[$langcode],
    ) : array();
    $uri
      ->setOptions($options);
    $row['title']['data'] = array(
      '#type' => 'link',
      '#title' => $entity
        ->label(),
      '#suffix' => ' ' . drupal_render($mark),
      '#url' => $uri,
    );
    $row['type'] = node_get_type_label($entity);
    $row['author']['data'] = array(
      '#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($langcode);
    }
    $row['operations']['data'] = $this
      ->buildOperations($entity);
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    $destination = $this->redirectDestination
      ->getAsArray();
    foreach ($operations as $key => $operation) {
      $operations[$key]['query'] = $destination;
    }
    return $operations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	3
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	3
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.	2
EntityListBuilder::$storage	protected	property	The entity storage class.
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	1
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
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	2
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	11
NodeListBuilder::$dateFormatter	protected	property	The date formatter service.
NodeListBuilder::$redirectDestination	protected	property	The redirect destination service.
NodeListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
NodeListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
NodeListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
NodeListBuilder::getDefaultOperations	protected	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
NodeListBuilder::__construct	public	function	Constructs a new NodeListBuilder object. Overrides EntityListBuilder::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.

You are here

class NodeListBuilder in Zircon Profile 8

Hierarchy

See also

File

Namespace

Members

API Navigation