interface AppCacheInterface in Apigee Edge 8

Base definition of an app cache for app controllers.

This cache stores app by using their app id as a cache id.

Hierarchy

• interface \Drupal\apigee_edge\Entity\Controller\Cache\EntityCacheInterface
  • interface \Drupal\apigee_edge\Entity\Controller\Cache\AppCacheInterface

5 files declare their use of AppCacheInterface

AppByOwnerController.php in src/Entity/Controller/AppByOwnerController.php

AppController.php in src/Entity/Controller/AppController.php

AppControllerBase.php in src/Entity/Controller/AppControllerBase.php

DeveloperAppControllerFactory.php in src/Entity/Controller/DeveloperAppControllerFactory.php

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

File

src/Entity/Controller/Cache/AppCacheInterface.php, line 30

Namespace

Drupal\apigee_edge\Entity\Controller\Cache

interface AppCacheInterface extends EntityCacheInterface {

  /**
   * Returns an app from the cache by its owner.
   *
   * Only developer id (UUID) and company name can be used as owner because
   * this is what is stored on the app entities.
   *
   * @param string $owner
   *   Developer id (UUID) or company name.
   *
   * @return \Apigee\Edge\Api\Management\Entity\AppInterface[]
   *   Array of apps that belongs to this owner in cache or null if no entry
   *   found in cache for this owner.
   */
  public function getAppsByOwner(string $owner) : ?array;

  /**
   * Remove all apps from the cache by their owner.
   *
   * Only developer id (UUID) and company name can be used as owner because
   * this is what is stored on the app entities.
   *
   * @param string $owner
   *   Developer id (UUID) or company name.
   */
  public function removeAppsByOwner(string $owner) : void;

  /**
   * Returns the owner of an app.
   *
   * @param \Apigee\Edge\Api\Management\Entity\AppInterface $app
   *   App entity.
   *
   * @return string
   *   Either developer id (UUID) or company name.
   */
  public function getAppOwner(AppInterface $app) : string;

}

Members

Name	Modifiers	Type	Description	Overrides
AppCacheInterface::getAppOwner	public	function	Returns the owner of an app.	1
AppCacheInterface::getAppsByOwner	public	function	Returns an app from the cache by its owner.	1
AppCacheInterface::removeAppsByOwner	public	function	Remove all apps from the cache by their owner.	1
EntityCacheInterface::allEntitiesInCache	public	function	Changes whether all entities in the cache or not.	2
EntityCacheInterface::getEntities	public	function	Returns entities from the cache.	2
EntityCacheInterface::getEntity	public	function	Returns an entity from the cache by its id.	2
EntityCacheInterface::isAllEntitiesInCache	public	function	Returns whether all entities in cache or not.	2
EntityCacheInterface::removeEntities	public	function	Removes entities from the cache by their ids.	2
EntityCacheInterface::saveEntities	public	function	Saves entities to the cache.	2