You are here

class RelationListBuilder in Relation 8

Same name and namespace in other branches
  1. 8.2 src/RelationListBuilder.php \Drupal\relation\RelationListBuilder

Provides a listing of relation types.

@todo: add filters

Hierarchy

Expanded class hierarchy of RelationListBuilder

File

src/RelationListBuilder.php, line 18
Contains \Drupal\relation\RelationListBuilder.

Namespace

Drupal\relation
View source
class RelationListBuilder extends EntityListBuilder {

  /**
   * The url generator service.
   *
   * @var \Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = t('Title');
    $header['relation_type'] = t('Type');
    $header['endpoints'] = t('Endpoints');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label']['data'] = array(
      '#type' => 'link',
      '#title' => $entity
        ->label(),
    ) + $entity
      ->toUrl()
      ->toRenderArray();
    $storage_handler = \Drupal::entityTypeManager()
      ->getStorage($entity
      ->getEntityType()
      ->getBundleEntityType());
    $bundle = $storage_handler
      ->load($entity
      ->bundle());
    $row['relation_type']['data'] = array(
      '#type' => 'link',
      '#title' => $bundle
        ->label(),
    ) + $bundle
      ->toUrl()
      ->toRenderArray();

    // Sort entities by their type.
    foreach ($entity->endpoints as $endpoint) {
      $entities[$endpoint->entity_type][] = $endpoint->entity_id;
    }
    $relation_entities = array();
    $entity_count_total = 0;
    $entity_count = 0;
    foreach ($entities as $type => $ids) {
      $entity_count_total += count(array_unique($ids));
      $storage_handler = \Drupal::entityTypeManager()
        ->getStorage($type);
      $endpoint_entities = $storage_handler
        ->loadMultiple($ids);
      foreach ($endpoint_entities as $endpoint_entity) {
        $entity_count++;
        $relation_entities[] = array(
          '#type' => 'link',
          '#title' => $endpoint_entity
            ->label(),
        ) + $endpoint_entity
          ->toUrl()
          ->toRenderArray();
      }
    }
    if ($entity_count_total != $entity_count) {
      $relation_entities[] = \Drupal::translation()
        ->formatPlural($entity_count_total - $entity_count, 'Missing @count entity', 'Missing @count entities');
    }
    $row['endpoints']['data']['list'] = array(
      '#theme' => 'item_list',
      '#items' => $relation_entities,
    );
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['#empty'] = t('No relations exist.');
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description 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::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations protected function Gets this list'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
EntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 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.
RelationListBuilder::$urlGenerator protected property The url generator service.
RelationListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
RelationListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
RelationListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
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.