CommentTypeListBuilder.php

Same filename in other branches
  1. 9 core/modules/comment/src/CommentTypeListBuilder.php
  2. 8.9.x core/modules/comment/src/CommentTypeListBuilder.php
  3. 10 core/modules/comment/src/CommentTypeListBuilder.php

Namespace

Drupal\comment

File

core/modules/comment/src/CommentTypeListBuilder.php

View source
<?php

namespace Drupal\comment;

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

/**
 * Defines a class to build a listing of comment type entities.
 *
 * @see \Drupal\comment\Entity\CommentType
 */
class CommentTypeListBuilder extends ConfigEntityListBuilder {
    
    /**
     * Constructs a new CommentTypeListBuilder 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\Entity\EntityTypeManagerInterface $entityTypeManager
     *   The entity type manager.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EntityTypeManagerInterface $entityTypeManager) {
        parent::__construct($entity_type, $storage);
    }
    
    /**
     * {@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('entity_type.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOperations(EntityInterface $entity) {
        $operations = parent::getDefaultOperations($entity);
        // Place the edit operation after the operations added by field_ui.module
        // which have the weights 15, 20, 25.
        if (isset($operations['edit'])) {
            $operations['edit']['weight'] = 30;
        }
        return $operations;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header['type'] = $this->t('Comment type');
        $header['description'] = $this->t('Description');
        $header['target'] = $this->t('Target entity type');
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        assert($entity instanceof CommentTypeInterface);
        $entity_type = $this->entityTypeManager
            ->getDefinition($entity->getTargetEntityTypeId());
        $row['type'] = $entity->label();
        $row['description']['data'] = [
            '#markup' => $entity->getDescription(),
        ];
        $row['target'] = $entity_type->getLabel();
        return $row + parent::buildRow($entity);
    }

}

Classes

Title Deprecated Summary
CommentTypeListBuilder Defines a class to build a listing of comment type entities.

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