class MediaListBuilder

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

Provides a listing of media items.

Hierarchy

Expanded class hierarchy of MediaListBuilder

File

core/modules/media/src/MediaListBuilder.php, line 16

Namespace

Drupal\media
View source
class MediaListBuilder extends EntityListBuilder {
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * The language manager service.
     *
     * @var \Drupal\Core\Language\LanguageManagerInterface
     */
    protected $languageManager;
    
    /**
     * Indicates whether the 'thumbnail' image style exists.
     *
     * @var bool
     */
    protected $thumbnailStyleExists = FALSE;
    
    /**
     * Constructs a new MediaListBuilder 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\Language\LanguageManagerInterface $language_manager
     *   The language manager service.
     * @param \Drupal\Core\Entity\EntityStorageInterface $image_style_storage
     *   The entity storage class for image styles.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, DateFormatterInterface $date_formatter, LanguageManagerInterface $language_manager, EntityStorageInterface $image_style_storage) {
        parent::__construct($entity_type, $storage);
        $this->dateFormatter = $date_formatter;
        $this->languageManager = $language_manager;
        $this->thumbnailStyleExists = !empty($image_style_storage->load('thumbnail'));
    }
    
    /**
     * {@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()), $container->get('date.formatter'), $container->get('language_manager'), $entity_type_manager->getStorage('image_style'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header = [];
        if ($this->thumbnailStyleExists) {
            $header['thumbnail'] = [
                'data' => $this->t('Thumbnail'),
                'class' => [
                    RESPONSIVE_PRIORITY_LOW,
                ],
            ];
        }
        $header += [
            'name' => $this->t('Media Name'),
            'type' => [
                'data' => $this->t('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,
                ],
            ],
        ];
        // Enable language column if multiple languages are added.
        if ($this->languageManager
            ->isMultilingual()) {
            $header['language'] = [
                'data' => $this->t('Language'),
                'class' => [
                    RESPONSIVE_PRIORITY_LOW,
                ],
            ];
        }
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        
        /** @var \Drupal\media\MediaInterface $entity */
        if ($this->thumbnailStyleExists) {
            $row['thumbnail'] = [];
            if ($thumbnail_uri = $entity->getSource()
                ->getMetadata($entity, 'thumbnail_uri')) {
                $row['thumbnail']['data'] = [
                    '#theme' => 'image_style',
                    '#style_name' => 'thumbnail',
                    '#uri' => $thumbnail_uri,
                    '#height' => 50,
                ];
            }
        }
        $row['name']['data'] = [
            '#type' => 'link',
            '#title' => $entity->label(),
            '#url' => $entity->toUrl(),
        ];
        $row['type'] = $entity->bundle->entity
            ->label();
        $row['author']['data'] = [
            '#theme' => 'username',
            '#account' => $entity->getOwner(),
        ];
        $row['status'] = $entity->isPublished() ? $this->t('Published') : $this->t('Unpublished');
        $row['changed'] = $this->dateFormatter
            ->format($entity->getChangedTime(), 'short');
        if ($this->languageManager
            ->isMultilingual()) {
            $row['language'] = $this->languageManager
                ->getLanguageName($entity->language()
                ->getId());
        }
        return $row + parent::buildRow($entity);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEntityIds() {
        $query = $this->getStorage()
            ->getQuery()
            ->accessCheck(TRUE)
            ->sort('changed', 'DESC');
        // Only add the pager if a limit is specified.
        if ($this->limit) {
            $query->pager($this->limit);
        }
        return $query->execute();
    }

}

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::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
EntityListBuilder::SORT_KEY protected constant The entity key to sort the list by. 1
MediaListBuilder::$dateFormatter protected property The date formatter service.
MediaListBuilder::$languageManager protected property The language manager service.
MediaListBuilder::$thumbnailStyleExists protected property Indicates whether the 'thumbnail' image style exists.
MediaListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
MediaListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
MediaListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
MediaListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
MediaListBuilder::__construct public function Constructs a new MediaListBuilder object. Overrides EntityListBuilder::__construct
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 '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.