interface EntityIdCacheInterface in Apigee Edge 8

Stores entity ids that getEntityIds() methods returns in controllers.

The primary entity id used in the SDK and in Drupal may not be the same as what wrapped API endpoint in a getEntityIds() method returns. Ex.: In case of developers, the primary id used in the SDK in the developerId (UUID) but the getEntityIds() method returns email addresses.

Hierarchy

• interface \Drupal\apigee_edge\Entity\Controller\Cache\EntityIdCacheInterface

See also

\Apigee\Edge\Controller\PaginatedEntityIdListingControllerInterface

\Apigee\Edge\Controller\NonPaginatedEntityIdListingControllerInterface

6 files declare their use of EntityIdCacheInterface

ApiProductController.php in src/Entity/Controller/ApiProductController.php

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

CachedPaginatedEntityIdListingControllerTrait.php in src/Entity/Controller/CachedPaginatedEntityIdListingControllerTrait.php

DeveloperController.php in src/Entity/Controller/DeveloperController.php

EntityControllerCacheUtilsTrait.php in tests/src/Traits/EntityControllerCacheUtilsTrait.php

... See full list

File

src/Entity/Controller/Cache/EntityIdCacheInterface.php, line 34

Namespace

Drupal\apigee_edge\Entity\Controller\Cache

interface EntityIdCacheInterface {

  /**
   * Returns cached ids.
   *
   * @return string[]
   *   Array of entity ids.
   */
  public function getIds() : array;

  /**
   * Adds entity ids to the cache.
   *
   * @param string[] $ids
   *   Array of entity ids to add.
   */
  public function saveIds(array $ids) : void;

  /**
   * Adds entities to the cache.
   *
   * @param \Apigee\Edge\Entity\EntityInterface[] $entities
   *   Array of entities.
   */
  public function saveEntities(array $entities) : void;

  /**
   * Removes ids from the cache.
   *
   * @param string[] $ids
   *   Array of ids to be removed.
   */
  public function removeIds(array $ids) : void;

  /**
   * Returns whether all entity ids in cache or not.
   *
   * @return bool
   *   Current state.
   */
  public function isAllIdsInCache() : bool;

  /**
   * Changes whether all ids in the cache or not.
   *
   * @param bool $all_ids_in_cache
   *   State to be set.
   */
  public function allIdsInCache(bool $all_ids_in_cache) : void;

}

Members

Name	Modifiers	Type	Description	Overrides
EntityIdCacheInterface::allIdsInCache	public	function	Changes whether all ids in the cache or not.	1
EntityIdCacheInterface::getIds	public	function	Returns cached ids.	1
EntityIdCacheInterface::isAllIdsInCache	public	function	Returns whether all entity ids in cache or not.	1
EntityIdCacheInterface::removeIds	public	function	Removes ids from the cache.	1
EntityIdCacheInterface::saveEntities	public	function	Adds entities to the cache.	1
EntityIdCacheInterface::saveIds	public	function	Adds entity ids to the cache.	1