You are here

Home » API reference » Entity Construction Kit (ECK) 8 » EckEntityTypeListBuilder.php

class EckEntityTypeListBuilder in Entity Construction Kit (ECK) 8

Provides a listing of ECK entities.

Hierarchy

Expanded class hierarchy of EckEntityTypeListBuilder

File

src/Controller/EckEntityTypeListBuilder.php, line 18

Namespace

Drupal\eck\Controller
View source 
class EckEntityTypeListBuilder extends ConfigEntityListBuilder {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * EckEntityTypeBundleInfo service.
   *
   * @var \Drupal\eck\EckEntityTypeBundleInfo
   */
  protected $eckBundleInfo;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'), $container
      ->get('eck.entity_type.bundle.info'));
  }

  /**
   * Constructs a new EntityListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\eck\EckEntityTypeBundleInfo $bundle_info
   *   ECK Entity Bundle Info service.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, EckEntityTypeBundleInfo $bundle_info) {
    $storage = $entity_type_manager
      ->getStorage($entity_type
      ->id());
    parent::__construct($entity_type, $storage);
    $this->entityTypeManager = $entity_type_manager;
    $this->eckBundleInfo = $bundle_info;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Entity Type');
    $header['machine_name'] = $this
      ->t('Machine Name');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->label();
    $row['machine_name'] = $entity
      ->id();
    if (!$this->eckBundleInfo
      ->entityTypeHasBundles($entity
      ->id())) {
      $row['operations']['data']['#links']['add_bundle'] = [
        'title' => $this
          ->t('Add bundle'),
        'url' => new Url('eck.entity.' . $entity
          ->id() . '_type.add'),
      ];
    }
    else {

      // Add link to list operation.
      $row['operations']['data']['#links']['add_content'] = [
        'title' => $this
          ->t('Add content'),
        'url' => new Url('eck.entity.add_page', [
          'eck_entity_type' => $entity
            ->id(),
        ]),
      ];

      // Directly link to the add entity page if there is only one bundle.
      if ($this->eckBundleInfo
        ->entityTypeBundleCount($entity
        ->id()) === 1) {
        $bundle_machine_names = $this->eckBundleInfo
          ->getEntityTypeBundleMachineNames($entity
          ->id());
        $arguments = [
          'eck_entity_type' => $entity
            ->id(),
          'eck_entity_bundle' => reset($bundle_machine_names),
        ];
        $row['operations']['data']['#links']['add_content']['url'] = new Url('eck.entity.add', $arguments);
      }
      $contentExists = (bool) $this->entityTypeManager
        ->getStorage($entity
        ->id())
        ->getQuery()
        ->accessCheck(FALSE)
        ->range(0, 1)
        ->execute();
      if ($contentExists) {

        // Add link to list operation.
        $row['operations']['data']['#links']['content_list'] = [
          'title' => $this
            ->t('Content list'),
          'url' => new Url('eck.entity.' . $entity
            ->id() . '.list'),
        ];
      }
    }
    $row['operations']['data']['#links']['bundle_list'] = [
      'title' => $this
        ->t('Bundle list'),
      'url' => new Url('eck.entity.' . $entity
        ->id() . '_type.list'),
    ];
    return array_merge_recursive($row, parent::buildRow($entity));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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
EckEntityTypeListBuilder::$eckBundleInfo protected property EckEntityTypeBundleInfo service.
EckEntityTypeListBuilder::$entityTypeManager protected property The entity type manager.
EckEntityTypeListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
EckEntityTypeListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
EckEntityTypeListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
EckEntityTypeListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
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::$storage protected property The entity storage class. 1
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::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
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 16
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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. 1
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.