You are here

class GroupMemberAccessCheck in Group 8

Same name and namespace in other branches
  1. 2.0.x src/Access/GroupMemberAccessCheck.php \Drupal\group\Access\GroupMemberAccessCheck

Determines access to routes based on whether a user is a member of a group.

Hierarchy

Expanded class hierarchy of GroupMemberAccessCheck

1 string reference to 'GroupMemberAccessCheck'
group.services.yml in ./group.services.yml
group.services.yml
1 service uses GroupMemberAccessCheck
access_check.group.member in ./group.services.yml
Drupal\group\Access\GroupMemberAccessCheck

File

src/Access/GroupMemberAccessCheck.php, line 15

Namespace

Drupal\group\Access
View source
class GroupMemberAccessCheck implements AccessInterface {

  /**
   * Checks access.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route to check against.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The parametrized route.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account to check access for.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access(Route $route, RouteMatchInterface $route_match, AccountInterface $account) {
    $member_only = $route
      ->getRequirement('_group_member') === 'TRUE';

    // Don't interfere if no group was specified.
    $parameters = $route_match
      ->getParameters();
    if (!$parameters
      ->has('group')) {
      return AccessResult::neutral();
    }

    // Don't interfere if the group isn't a real group.
    $group = $parameters
      ->get('group');
    if (!$group instanceof GroupInterface) {
      return AccessResult::neutral();
    }

    // Only allow access if the user is a member of the group and _group_member
    // is set to TRUE or the other way around.
    return AccessResult::allowedIf($group
      ->getMember($account) xor !$member_only);
  }

}

Members