interface EdgeEntityControllerInterface in Apigee Edge 8

Provides a unified way for making CRUDL APIs calls to Apigee Edge.

Every Apigee Edge entity that would like to be a full-flagged Drupal entity must support these basic operations, because this is the minimum that entity storages requires.

(Although these operations can throw an exception or do nothing if some operation is not supporter. This could occur in case of Monetization entities, ex.: an API package can not be deleted or updated.)

Hierarchy

• interface \Drupal\apigee_edge\Entity\Controller\EdgeEntityControllerInterface

7 files declare their use of EdgeEntityControllerInterface

ApiProductStorage.php in src/Entity/Storage/ApiProductStorage.php

DeveloperAppStorage.php in src/Entity/Storage/DeveloperAppStorage.php

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

EdgeEntityStorageBase.php in src/Entity/Storage/EdgeEntityStorageBase.php

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

... See full list

File

src/Entity/Controller/EdgeEntityControllerInterface.php, line 36

Namespace

Drupal\apigee_edge\Entity\Controller

interface EdgeEntityControllerInterface {

  /**
   * Creates an entity in Apigee Edge.
   *
   * Applies incoming values from Apigee Edge in $entity.
   *
   * @param \Apigee\Edge\Entity\EntityInterface $entity
   *   The created entity.
   */
  public function create(EntityInterface $entity) : void;

  /**
   * Loads an entity from Apigee Edge.
   *
   * @param string $id
   *   One of an entity's unique ids. (Some entities has more than one unique
   *   id at a moment, ex.: developer's email address and id (UUID).)
   *
   * @return \Apigee\Edge\Entity\EntityInterface
   *   The load entity from Apigee Edge.
   *
   * @throws \Apigee\Edge\Exception\ApiException
   *   If entity does not exist with id.
   */
  public function load(string $id) : EntityInterface;

  /**
   * Updates an entity in Apigee Edge.
   *
   * Applies incoming values from Apigee Edge in $entity.
   *
   * @param \Apigee\Edge\Entity\EntityInterface $entity
   *   The update entity.
   */
  public function update(EntityInterface $entity) : void;

  /**
   * Removes an entity from Apigee Edge.
   *
   * @param string $id
   *   One of an entity's unique ids. (Some entities has more than one unique
   *   id at a moment, ex.: developer's email address and id (UUID).)
   */
  public function delete(string $id) : void;

  /**
   * Loads _all_ entities from Apigee Edge.
   *
   * All entities, even on pagination enabled endpoints, this method must
   * return all entities even it requires multiple API calls.
   *
   * @return \Apigee\Edge\Entity\EntityInterface[]
   *   Array of entities.
   */
  public function loadAll() : array;

}

Members

Name	Modifiers	Type	Description	Overrides
EdgeEntityControllerInterface::create	public	function	Creates an entity in Apigee Edge.	4
EdgeEntityControllerInterface::delete	public	function	Removes an entity from Apigee Edge.	4
EdgeEntityControllerInterface::load	public	function	Loads an entity from Apigee Edge.	4
EdgeEntityControllerInterface::loadAll	public	function	Loads _all_ entities from Apigee Edge.	4
EdgeEntityControllerInterface::update	public	function	Updates an entity in Apigee Edge.	4