interface EntityCacheInterface in Apigee Edge 8

Base definition of the entity cache used by controllers.

Stores entities returned by entity controllers.

Hierarchy

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

9 files declare their use of EntityCacheInterface

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

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

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

CachedManagementApiEdgeEntityControllerProxy.php in src/Entity/Controller/CachedManagementApiEdgeEntityControllerProxy.php

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

... See full list

File

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

Namespace

Drupal\apigee_edge\Entity\Controller\Cache

interface EntityCacheInterface {

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

  /**
   * Removes entities from the cache by their ids.
   *
   * @param string[] $ids
   *   Array of entity ids.
   */
  public function removeEntities(array $ids) : void;

  /**
   * Returns entities from the cache.
   *
   * @param array $ids
   *   Array of entity ids.
   *   If an empty array is passed all currently stored gets returned.
   *
   * @return \Apigee\Edge\Entity\EntityInterface[]
   *   Array of entities.
   */
  public function getEntities(array $ids = []) : array;

  /**
   * Returns an entity from the cache by its id.
   *
   * @param string $id
   *   Entity id.
   *
   * @return \Apigee\Edge\Entity\EntityInterface|null
   *   The entity if it is in the cache, null otherwise.
   */
  public function getEntity(string $id) : ?EntityInterface;

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
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