class ModeratedNodeListBuilder

Same name in other branches
  1. 9 core/modules/content_moderation/src/ModeratedNodeListBuilder.php \Drupal\content_moderation\ModeratedNodeListBuilder
  2. 10 core/modules/content_moderation/src/ModeratedNodeListBuilder.php \Drupal\content_moderation\ModeratedNodeListBuilder
  3. 11.x core/modules/content_moderation/src/ModeratedNodeListBuilder.php \Drupal\content_moderation\ModeratedNodeListBuilder

Defines a class to build a listing of moderated node entities.

Hierarchy

Expanded class hierarchy of ModeratedNodeListBuilder

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

File

core/modules/content_moderation/src/ModeratedNodeListBuilder.php, line 17

Namespace

Drupal\content_moderation
View source
class ModeratedNodeListBuilder extends NodeListBuilder {
    
    /**
     * The entity storage class.
     *
     * @var \Drupal\Core\Entity\RevisionableStorageInterface
     */
    protected $storage;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a new ModeratedNodeListBuilder 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.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, DateFormatterInterface $date_formatter, RedirectDestinationInterface $redirect_destination, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($entity_type, $storage, $date_formatter, $redirect_destination);
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@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('redirect.destination'), $entity_type_manager);
    }
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $revision_ids = $this->getEntityRevisionIds();
        return $this->storage
            ->loadMultipleRevisions($revision_ids);
    }
    
    /**
     * Loads entity revision IDs using a pager sorted by the entity revision ID.
     *
     * @return array
     *   An array of entity revision IDs.
     */
    protected function getEntityRevisionIds() {
        $query = $this->entityTypeManager
            ->getStorage('content_moderation_state')
            ->getAggregateQuery()
            ->aggregate('content_entity_id', 'MAX')
            ->groupBy('content_entity_revision_id')
            ->condition('content_entity_type_id', $this->entityTypeId)
            ->condition('moderation_state', 'published', '<>')
            ->sort('content_entity_revision_id', 'DESC');
        // Only add the pager if a limit is specified.
        if ($this->limit) {
            $query->pager($this->limit);
        }
        $result = $query->execute();
        return $result ? array_column($result, 'content_entity_revision_id') : [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header = parent::buildHeader();
        $header['status'] = $this->t('Moderation state');
        return $header;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row = parent::buildRow($entity);
        $row['status'] = $entity->moderation_state->value;
        return $row;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        $build = parent::render();
        $build['table']['#empty'] = $this->t('There is no moderated @label yet. Only pending versions of @label, such as drafts, are listed here.', [
            '@label' => $this->entityType
                ->getLabel(),
        ]);
        return $build;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
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. 3
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.
EntityListBuilder::getDefaultOperations protected function Gets this list&#039;s default operations. 2
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
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
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
ModeratedNodeListBuilder::$entityTypeManager protected property The entity type manager.
ModeratedNodeListBuilder::$storage protected property The entity storage class. Overrides EntityListBuilder::$storage
ModeratedNodeListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides NodeListBuilder::buildHeader
ModeratedNodeListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides NodeListBuilder::buildRow
ModeratedNodeListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides NodeListBuilder::createInstance
ModeratedNodeListBuilder::getEntityRevisionIds protected function Loads entity revision IDs using a pager sorted by the entity revision ID.
ModeratedNodeListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
ModeratedNodeListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
ModeratedNodeListBuilder::__construct public function Constructs a new ModeratedNodeListBuilder object. Overrides NodeListBuilder::__construct
NodeListBuilder::$dateFormatter protected property The date formatter service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
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.