interface DeveloperCompaniesCacheInterface in Apigee Edge 8

Definition of the developer company membership cache.

@internal This cache only exists to allow developers to reload list of companies returned by Developer::getCompanies().

Hierarchy

• interface \Drupal\apigee_edge\Entity\DeveloperCompaniesCacheInterface

See also

\Drupal\apigee_edge\Entity\Developer::getCompanies()

4 files declare their use of DeveloperCompaniesCacheInterface

DeveloperStorage.php in src/Entity/Storage/DeveloperStorage.php

TeamController.php in modules/apigee_edge_teams/src/Entity/Controller/TeamController.php

TeamMembershipManager.php in modules/apigee_edge_teams/src/TeamMembershipManager.php

TeamMembershipManager.php in modules/apigee_edge_actions/src/TeamMembershipManager.php

File

src/Entity/DeveloperCompaniesCacheInterface.php, line 31

Namespace

Drupal\apigee_edge\Entity

interface DeveloperCompaniesCacheInterface {

  /**
   * Returns companies of a developer.
   *
   * @param string $id
   *   Developer id.
   *
   * @return string[]|null
   *   Array of company names or NULL if information is not yet available.
   */
  public function getCompanies(string $id) : ?array;

  /**
   * Saves developers' companies to cache.
   *
   * @param \Apigee\Edge\Api\Management\Entity\DeveloperInterface[] $developers
   *   Developer entities.
   */
  public function saveCompanies(array $developers) : void;

  /**
   * Removes cached company information of a developer.
   *
   * @param array $ids
   *   Array of developer ids, if the array is empty all entries gets removed.
   */
  public function remove(array $ids = []) : void;

  /**
   * Invalidates cache entries by tag.
   *
   * @param array $tags
   *   Array of cache tags.
   */
  public function invalidate(array $tags) : void;

}

Members

Name	Modifiers	Type	Description	Overrides
DeveloperCompaniesCacheInterface::getCompanies	public	function	Returns companies of a developer.	1
DeveloperCompaniesCacheInterface::invalidate	public	function	Invalidates cache entries by tag.	1
DeveloperCompaniesCacheInterface::remove	public	function	Removes cached company information of a developer.	1
DeveloperCompaniesCacheInterface::saveCompanies	public	function	Saves developers' companies to cache.	1