You are here

Home » API reference » Apigee Edge 8 » TeamListBuilder.php

class TeamListBuilder in Apigee Edge 8

General entity listing builder for teams.

Hierarchy

Expanded class hierarchy of TeamListBuilder

File

modules/apigee_edge_teams/src/Entity/ListBuilder/TeamListBuilder.php, line 33

Namespace

Drupal\apigee_edge_teams\Entity\ListBuilder
View source 
class TeamListBuilder extends EdgeEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $headers = [];
    $headers['name'] = [
      'data' => $this
        ->t('@entity_type name', [
        '@entity_type' => ucfirst($this->entityType
          ->getSingularLabel()),
      ]),
      'specifier' => 'displayName',
      'field' => 'displayName',
      'sort' => 'desc',
    ];
    $headers['status'] = [
      'data' => $this
        ->t('Status'),
      'specifier' => 'status',
      'field' => 'status',
    ];
    return $headers + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    $team_app_list_url = Url::fromRoute('entity.team_app.collection_by_team', [
      'team' => $entity
        ->id(),
    ]);
    if ($team_app_list_url
      ->access()) {
      $team_app_entity_def = $this->entityTypeManager
        ->getDefinition('team_app');
      $operations['apps'] = [
        'title' => $team_app_entity_def
          ->getCollectionLabel(),
        'url' => $team_app_list_url,
        'weight' => -10,
      ];
    }
    if ($entity
      ->hasLinkTemplate('members')) {
      $members_url = $entity
        ->toUrl('members');
      if ($members_url
        ->access()) {
        $operations['members'] = [
          'title' => $this
            ->t('Members'),
          'url' => $members_url,
        ];
      }
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function load() {

    // Compared with a usual entity collection page this listing page is also
    // available to _all_ logged in users so it must be ensured that users
    // can see only those teams in this list that they have view access.
    // @see \Drupal\apigee_edge_teams\Entity\TeamAccessHandler
    return array_filter(parent::load(), function (TeamInterface $entity) {
      return $entity
        ->access('view');
    });
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\apigee_edge_teams\Entity\TeamInterface $entity */
    $row['name']['data'] = $entity
      ->toLink()
      ->toRenderable();
    $row['status']['data'] = [
      '#type' => 'status_property',
      '#value' => $entity
        ->getStatus(),
      '#indicator_status' => $entity
        ->getStatus() === TeamInterface::STATUS_ACTIVE ? StatusPropertyElement::INDICATOR_STATUS_OK : StatusPropertyElement::INDICATOR_STATUS_ERROR,
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->load(\Drupal::currentUser()
      ->id());
    $build = empty($build['table']) ? $build : $build['table'];
    $build['#cache']['keys'][] = 'team_list_per_user';

    // Team lists vary for each user and their permissions.
    // Note: Even though cache contexts will be optimized to only include the
    // 'user' cache context, the element should be invalidated correctly when
    // permissions change because the 'user.permissions' cache context defined
    // cache tags for permission changes, which should have bubbled up for the
    // element when it was optimized away.
    // @see \Drupal\KernelTests\Core\Cache\CacheContextOptimizationTest
    $build['#cache']['contexts'][] = 'user';
    $build['#cache']['contexts'][] = 'user.permissions';
    $build['#cache']['tags'] = Cache::mergeTags($build['#cache']['tags'], $account
      ->getCacheTags());

    // Use cache expiration defined in configuration.
    $build['#cache']['max-age'] = $this->configFactory
      ->get('apigee_edge_teams.team_settings')
      ->get('cache_expiration');
    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
EdgeEntityListBuilder::$configFactory protected property The config factory. 1
EdgeEntityListBuilder::$entityTypeManager protected property The entity type manager service.
EdgeEntityListBuilder::buildEntityIdQuery protected function Builds an entity query used by entity listing. 2
EdgeEntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance 1
EdgeEntityListBuilder::DEFAULT_DISPLAY_TYPE constant The default display type.
EdgeEntityListBuilder::getCacheMaxAge protected function Returns the cache max age. 2
EdgeEntityListBuilder::getDisplaySettings protected function Returns the display settings.
EdgeEntityListBuilder::getEntityIds final protected function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
EdgeEntityListBuilder::renderUsingViewMode protected function Renders a list of entities using the provided view mode.
EdgeEntityListBuilder::usingDisplayType protected function Returns TRUE if entity type is configure to use provided display type.
EdgeEntityListBuilder::VIEW_MODE_DISPLAY_TYPE constant The view mode display type.
EdgeEntityListBuilder::__construct public function EdgeEntityListBuilder constructor. Overrides EntityListBuilder::__construct 1
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::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. 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.
TeamListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
TeamListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
TeamListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
TeamListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
TeamListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EdgeEntityListBuilder::render