You are here

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

class TeamMembersList in Apigee Edge 8

Team members list builder for a team.

Hierarchy

Expanded class hierarchy of TeamMembersList

1 file declares its use of TeamMembersList
TeamRouteProvider.php in modules/apigee_edge_teams/src/Entity/TeamRouteProvider.php

File

modules/apigee_edge_teams/src/Controller/TeamMembersList.php, line 39

Namespace

Drupal\apigee_edge_teams\Controller
View source 
class TeamMembersList extends ControllerBase {

  /**
   * The team membership manager service.
   *
   * @var \Drupal\apigee_edge_teams\TeamMembershipManagerInterface
   */
  private $teamMembershipManager;

  /**
   * Default member roles.
   *
   * @var array
   */
  protected $defaultRoles = [];

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface|null
   */
  protected $moduleHandler;

  /**
   * TeamMembersList constructor.
   *
   * @param \Drupal\apigee_edge_teams\TeamMembershipManagerInterface $team_membership_manager
   *   The team membership manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface|null $module_handler
   *   The module handler.
   */
  public function __construct(TeamMembershipManagerInterface $team_membership_manager, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler = NULL) {
    if (!$module_handler) {
      @trigger_error('Calling ' . __METHOD__ . ' without the $module_handler is deprecated in apigee_edge:8-x-1.19 and is required before apigee_edge:8.x-2.0. See https://github.com/apigee/apigee-edge-drupal/pull/518.', E_USER_DEPRECATED);
      $module_handler = \Drupal::moduleHandler();
    }
    $this->teamMembershipManager = $team_membership_manager;
    $this->entityTypeManager = $entity_type_manager;
    if ($role = $this
      ->entityTypeManager()
      ->getStorage('team_role')
      ->load(TeamRoleInterface::TEAM_MEMBER_ROLE)) {
      $this->defaultRoles = [
        $role
          ->id() => $role
          ->label(),
      ];
    }
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('apigee_edge_teams.team_membership_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('module_handler'));
  }

  /**
   * Returns a list of team members.
   *
   * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
   *   The team which members gets listed.
   *
   * @return array
   *   Render array.
   *
   * @see \Drupal\apigee_edge_teams\Entity\TeamRouteProvider::getListTeamMembersRoute()
   */
  public function overview(TeamInterface $team) {
    $entity_type = $this
      ->entityTypeManager()
      ->getDefinition('team');
    $members = $this->teamMembershipManager
      ->getMembers($team
      ->id());
    $users_by_mail = [];
    $team_member_roles_by_mail = [];
    if (!empty($members)) {
      $user_storage = $this
        ->entityTypeManager()
        ->getStorage('user');
      $uids = $user_storage
        ->getQuery()
        ->condition('mail', $members, 'IN')
        ->execute();
      $users_by_mail = array_reduce($user_storage
        ->loadMultiple($uids), function ($carry, UserInterface $item) {
        $carry[$item
          ->getEmail()] = $item;
        return $carry;
      }, []);

      /** @var \Drupal\apigee_edge_teams\Entity\Storage\TeamMemberRoleStorageInterface $team_member_role_storage */
      $team_member_role_storage = $this
        ->entityTypeManager()
        ->getStorage('team_member_role');
      $team_member_roles_by_mail = array_reduce($team_member_role_storage
        ->loadByTeam($team), function ($carry, TeamMemberRoleInterface $developer_role) {
        $carry[$developer_role
          ->getDeveloper()
          ->getEmail()] = $developer_role;
        return $carry;
      }, []);
    }
    $build['table'] = [
      '#type' => 'table',
      '#header' => [
        'member' => $this
          ->t('Member'),
        'roles' => $this
          ->t('Roles'),
        'operations' => $this
          ->t('Operations'),
      ],
      '#title' => $this
        ->t('@team Members', [
        '@team' => $entity_type
          ->getSingularLabel(),
      ]),
      '#rows' => [],
      '#empty' => $this
        ->t('There are no members yet.'),
      '#cache' => [
        'contexts' => $team
          ->getCacheContexts(),
        'tags' => $team
          ->getCacheTags(),
      ],
    ];

    // The list is ordered in the same order as the API returns the members.
    foreach ($members as $member) {
      $build['table']['#rows'][$member] = $this
        ->buildRow($member, $users_by_mail, $team_member_roles_by_mail, $team);
    }

    // Add invitations.
    if ($invitation_view = Views::getView('team_invitations')) {
      $build['invitations'] = $invitation_view
        ->buildRenderable('team', [
        'team' => $team
          ->id(),
      ]);
    }
    return $build;
  }

  /**
   * Builds a row for a team member.
   *
   * @param string $member
   *   The email address of a member (developer).
   * @param array $users_by_mail
   *   Associative array of Drupal users keyed by their email addresses. The
   *   list only contains those Drupal users who are member of the team.
   * @param \Drupal\apigee_edge_teams\Entity\TeamMemberRoleInterface[] $team_member_roles_by_mail
   *   Associative array of team member roles keyed by email addresses.
   * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
   *   The team that the member belongs.
   *
   * @return array
   *   Render array.
   */
  protected function buildRow(string $member, array $users_by_mail, array $team_member_roles_by_mail, TeamInterface $team) : array {
    $row = [];
    $row['id'] = Html::getUniqueId($member);
    if (array_key_exists($member, $users_by_mail)) {

      // @see \Drupal\user\UserAccessControlHandler::checkAccess()
      $row['data']['member'] = $users_by_mail[$member]
        ->access('view') ? $users_by_mail[$member]
        ->toLink() : "{$users_by_mail[$member]->label()} ({$member})";
    }
    else {

      // We only display the email address of the member in this case
      // because displaying its first name and last name would require API
      // call(s). We can not load only a set of developers from Apigee Edge
      // (like we loaded only the necessary amount of Drupal users), we can only
      // all developers which could unnecessarily slow down this page if the
      // developer entity cache is cold.
      $row['data']['member'] = $member;
    }
    if (array_key_exists($member, $team_member_roles_by_mail)) {
      $roles = array_reduce($team_member_roles_by_mail[$member]
        ->getTeamRoles(), function ($carry, TeamRoleInterface $role) {
        $carry[$role
          ->id()] = $role
          ->label();
        return $carry;
      }, $this->defaultRoles);
      $row['data']['roles']['data'] = [
        '#theme' => 'item_list',
        '#items' => $roles,
        '#cache' => [
          'contexts' => $team_member_roles_by_mail[$member]
            ->getCacheContexts(),
          'tags' => $team_member_roles_by_mail[$member]
            ->getCacheTags(),
        ],
      ];
    }
    else {
      $row['data']['roles']['data'] = [
        '#theme' => 'item_list',
        '#items' => $this->defaultRoles,
      ];
    }
    $row['data']['operations']['data'] = $this
      ->buildOperations($member, $team);
    return $row;
  }

  /**
   * Builds operations for a member.
   *
   * @param string $member
   *   The email address of a member (developer).
   * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
   *   The team that the member belongs.
   *
   * @return array
   *   Render array.
   */
  protected function buildOperations(string $member, TeamInterface $team) : array {
    return [
      '#type' => 'operations',
      '#links' => $this
        ->getOperations($member, $team),
    ];
  }

  /**
   * Returns available operations for a member.
   *
   * @param string $member
   *   The email address of a member (developer).
   * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
   *   The team that the member belongs.
   *
   * @return array
   *   Array of operation links.
   */
  protected function getOperations(string $member, TeamInterface $team) {
    $operations = [];
    $url = Url::fromRoute('entity.team.member.edit', [
      'team' => $team
        ->id(),
      'developer' => $member,
    ], [
      'query' => [
        'destination' => $team
          ->toUrl('members')
          ->toString(),
      ],
    ]);
    if ($url
      ->access()) {
      $operations['edit'] = [
        'title' => $this
          ->t('Edit'),
        'url' => $url,
      ];
    }
    $url = Url::fromRoute('entity.team.member.remove', [
      'team' => $team
        ->id(),
      'developer' => $member,
    ], [
      'query' => [
        'destination' => $team
          ->toUrl('members')
          ->toString(),
      ],
    ]);
    if ($url
      ->access()) {
      $operations['remove'] = [
        'title' => $this
          ->t('Remove'),
        'url' => $url,
      ];
    }

    // Allow modules to alter operations.
    $this->moduleHandler
      ->alter('entity_operation', $operations, $team);
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
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.
TeamMembersList::$defaultRoles protected property Default member roles.
TeamMembersList::$moduleHandler protected property The module handler. Overrides ControllerBase::$moduleHandler
TeamMembersList::$teamMembershipManager private property The team membership manager service.
TeamMembersList::buildOperations protected function Builds operations for a member.
TeamMembersList::buildRow protected function Builds a row for a team member.
TeamMembersList::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
TeamMembersList::getOperations protected function Returns available operations for a member.
TeamMembersList::overview public function Returns a list of team members.
TeamMembersList::__construct public function TeamMembersList constructor.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.