CompanyMembersController.php in Apigee Edge 8

Namespace

Drupal\apigee_edge_teams

File

modules/apigee_edge_teams/src/CompanyMembersController.php

<?php

/**
 * Copyright 2018 Google Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */
namespace Drupal\apigee_edge_teams;

use Apigee\Edge\Api\Management\Controller\CompanyMembersController as EdgeCompanyMembersController;
use Apigee\Edge\Api\Management\Structure\CompanyMembership;
use Drupal\apigee_edge\SDKConnectorInterface;

/**
 * Definition of the Company members controller service.
 *
 * @internal You should use the team membership manager service instead of this.
 */
final class CompanyMembersController implements CompanyMembersControllerInterface {

  /**
   * Name of a company.
   *
   * @var string
   */
  private $company;

  /**
   * The SDK connector service.
   *
   * @var \Drupal\apigee_edge\SDKConnectorInterface
   */
  private $connector;

  /**
   * The company membership object cache.
   *
   * @var \Drupal\apigee_edge_teams\CompanyMembershipObjectCacheInterface
   */
  private $companyMembershipObjectCache;

  /**
   * CompanyMembersController constructor.
   *
   * @param string $company
   *   The name of the company.
   * @param \Drupal\apigee_edge\SDKConnectorInterface $connector
   *   The SDK connector service.
   * @param \Drupal\apigee_edge_teams\CompanyMembershipObjectCacheInterface $company_membership_object_cache
   *   The company membership object cache.
   */
  public function __construct(string $company, SDKConnectorInterface $connector, CompanyMembershipObjectCacheInterface $company_membership_object_cache) {
    $this->company = $company;
    $this->connector = $connector;
    $this->companyMembershipObjectCache = $company_membership_object_cache;
  }

  /**
   * Returns the decorated company members controller from the SDK.
   *
   * @return \Apigee\Edge\Api\Management\Controller\CompanyMembersController
   *   The initialized company members controller.
   */
  private function decorated() : EdgeCompanyMembersController {
    return new EdgeCompanyMembersController($this->company, $this->connector
      ->getOrganization(), $this->connector
      ->getClient());
  }

  /**
   * {@inheritdoc}
   */
  public function getCompanyName() : string {
    return $this
      ->decorated()
      ->getCompanyName();
  }

  /**
   * {@inheritdoc}
   */
  public function getMembers() : CompanyMembership {
    if ($this->companyMembershipObjectCache
      ->getMembership($this->company) === NULL) {
      $membership = $this
        ->decorated()
        ->getMembers();
      $this->companyMembershipObjectCache
        ->saveMembership($this->company, $membership);
    }
    return $this->companyMembershipObjectCache
      ->getMembership($this->company);
  }

  /**
   * {@inheritdoc}
   */
  public function setMembers(CompanyMembership $members) : CompanyMembership {
    $result = $this
      ->decorated()
      ->setMembers($members);

    // Returned membership does not contain all actual members of the company,
    // so it is easier to remove the membership object from the cache and
    // enforce reload in getMembers().
    $this->companyMembershipObjectCache
      ->removeMembership($this->company);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function removeMember(string $email) : void {
    $this
      ->decorated()
      ->removeMember($email);
    $this->companyMembershipObjectCache
      ->removeMembership($this->company);
  }

}

Classes

Name	Description
CompanyMembersController	Definition of the Company members controller service.