DateFormatListBuilder.php

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

Namespace

Drupal\system

File

core/modules/system/src/DateFormatListBuilder.php

View source
<?php

namespace Drupal\system;

use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines a class to build a listing of date format entities.
 *
 * @see \Drupal\system\Entity\DateFormat
 */
class DateFormatListBuilder extends ConfigEntityListBuilder {
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * Constructs a new DateFormatListBuilder 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.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, DateFormatterInterface $date_formatter) {
        parent::__construct($entity_type, $storage);
        $this->dateFormatter = $date_formatter;
    }
    
    /**
     * {@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'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header['label'] = t('Name');
        $header['pattern'] = t('Pattern');
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row['label'] = $entity->label();
        $row['pattern'] = $this->dateFormatter
            ->format(REQUEST_TIME, $entity->id());
        return $row + parent::buildRow($entity);
    }

}

Classes

Title Deprecated Summary
DateFormatListBuilder Defines a class to build a listing of date format entities.

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