You are here

Home » API reference » Apigee Edge 8 » EdgeEntityInterface.php

interface EdgeEntityInterface in Apigee Edge 8

Interface EdgeEntityInterface.

The order of extended interfaces matters. SdkEntityInterface::id() is more strict than DrupalEntityInterface::id().

Hierarchy

Expanded class hierarchy of EdgeEntityInterface

All classes that implement EdgeEntityInterface

4 files declare their use of EdgeEntityInterface
apigee_edge_actions.tokens.inc in modules/apigee_edge_actions/apigee_edge_actions.tokens.inc
Implements tokens for Apigee Edge entities.
EdgeEntityFieldConfigListRouteSubscriber.php in src/Routing/EdgeEntityFieldConfigListRouteSubscriber.php
EdgeEntityStorageBase.php in src/Entity/Storage/EdgeEntityStorageBase.php
StatusPropertyFormatter.php in src/Plugin/Field/FieldFormatter/StatusPropertyFormatter.php

File

src/Entity/EdgeEntityInterface.php, line 32

Namespace

Drupal\apigee_edge\Entity
View source 
interface EdgeEntityInterface extends SdkEntityInterface, DrupalEntityInterface {

  /**
   * Creates a Drupal entity from an SDK Entity.
   *
   * @param \Apigee\Edge\Entity\EntityInterface $entity
   *   Entity from the PHP SDK.
   *
   * @return \Drupal\apigee_edge\Entity\EdgeEntityInterface
   *   Drupal entity that decorates the SDK entity.
   */
  public static function createFrom(SdkEntityInterface $entity) : self;

  /**
   * Returns all unique ids how an entity can be referenced in Apigee Edge.
   *
   * All these ids can be used in Drupal to load entity as well.
   *
   * Ex.: Developer can be referenced by its UUID or its email address.
   *
   * @return string[]
   *   Array of entity properties that stores unique entity ids. Returned
   *   properties must have a public getter, ex.: 'get' . ucfirst($property).
   */
  public static function uniqueIdProperties() : array;

  /**
   * List of unique ids how an entity can be referenced in Apigee Edge.
   *
   * It must return the values of the properties returned by idProperties().
   *
   * @see \Drupal\apigee_edge\Entity\EdgeEntityInterface::uniqueIdProperties()
   *
   * @return string[]
   *   Array of unique ids on the entity.
   */
  public function uniqueIds() : array;

  /**
   * Returns the decorated SDK entity.
   *
   * THIS IS AN INTERNAL METHOD! You should not do modifications on the
   * decorated entity object, you should use the decorators for this.
   * This method only exists because entity storages uses it.
   *
   * @return \Apigee\Edge\Entity\EntityInterface
   *   The decorated SDK entity.
   *
   * @internal
   */
  public function decorated() : SdkEntityInterface;

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
EdgeEntityInterface::createFrom public static function Creates a Drupal entity from an SDK Entity. 1
EdgeEntityInterface::decorated public function Returns the decorated SDK entity. 1
EdgeEntityInterface::uniqueIdProperties public static function Returns all unique ids how an entity can be referenced in Apigee Edge. 1
EdgeEntityInterface::uniqueIds public function List of unique ids how an entity can be referenced in Apigee Edge. 1
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1