abstract class EdgeEntityBase in Apigee Edge 8

Base class for Apigee Edge entities in Drupal.

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\apigee_edge\Entity\EdgeEntityBase implements EdgeEntityInterface

Expanded class hierarchy of EdgeEntityBase

File

src/Entity/EdgeEntityBase.php, line 31

Namespace

Drupal\apigee_edge\Entity

View source

abstract class EdgeEntityBase extends EntityBase implements EdgeEntityInterface {

  /**
   * The decorated SDK entity.
   *
   * @var \Apigee\Edge\Entity\EntityInterface
   */
  protected $decorated;

  /**
   * EdgeEntityBase constructor.
   *
   * @param array $values
   *   An array of values to set, keyed by property name.
   * @param null|string $entity_type
   *   Type of the entity.
   * @param \Apigee\Edge\Entity\EntityInterface|null $decorated
   *   The SDK entity that this Drupal entity decorates.
   *
   * @throws \ReflectionException
   */
  public function __construct(array $values, string $entity_type, ?EntityInterface $decorated = NULL) {
    parent::__construct([], $entity_type);
    if ($decorated) {
      $this->decorated = $decorated;
    }
    else {
      $rc = new \ReflectionClass($this
        ->decoratedClass());
      if (!$rc
        ->implementsInterface(EntityInterface::class)) {
        throw new InvalidArgumentException(sprintf('"%s" interface must be implemented by the decorated class.', $rc
          ->getName()));
      }

      // Get rid of useless but also problematic null values.
      // (SDK entity classes do not like them.)
      $values = array_filter($values, function ($value) {
        return !is_null($value);
      });
      $this->decorated = $rc
        ->newInstance($values);
    }
  }

  /**
   * The FQCN of the decorated class from the PHP API Client.
   *
   * @return string
   *   FQCN of the entity class.
   */
  protected static abstract function decoratedClass() : string;

  /**
   * {@inheritdoc}
   *
   * We have to override this to make it compatible with the SDK's
   * entity interface that enforces the return type.
   */
  public function id() : ?string {
    return $this
      ->drupalEntityId();
  }

  /**
   * Return the entity id used in Drupal.
   *
   * @return null|string
   *   Null if the entity is new.
   */
  protected abstract function drupalEntityId() : ?string;

  /**
   * {@inheritdoc}
   */
  public static function uniqueIdProperties() : array {
    return [
      static::idProperty(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function uniqueIds() : array {
    $ids = [];
    $ro = new \ReflectionObject($this);
    foreach (static::uniqueIdProperties() as $property) {
      $getter = 'get' . ucfirst($property);
      $ids[] = $ro
        ->getMethod($getter)
        ->invoke($this);
    }
    return $ids;
  }

  /**
   * Creates a Drupal entity from an SDK Entity.
   *
   * @param \Apigee\Edge\Entity\EntityInterface $entity
   *   An SDK entity.
   *
   * @return \Drupal\apigee_edge\Entity\EdgeEntityInterface
   *   The Drupal entity that decorates the SDK entity.
   */
  public static function createFrom(EntityInterface $entity) : EdgeEntityInterface {
    return new static([], NULL, $entity);
  }

  /**
   * {@inheritdoc}
   */
  public function decorated() : EntityInterface {
    return $this->decorated;
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    $label = parent::label();
    if ($label === NULL) {
      if (in_array(DisplayNamePropertyInterface::class, class_implements($this)) && !empty($this
        ->getDisplayName())) {
        $label = $this
          ->getDisplayName();
      }
      else {
        $label = $this
          ->id();
      }
    }
    return $label;
  }

  /**
   * {@inheritdoc}
   */
  public function isTranslatable() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getTranslation($langcode) {
    if ($langcode == $this
      ->language()
      ->getId()) {
      return $this;
    }
    throw new \InvalidArgumentException("Invalid translation language ({$langcode}) specified.");
  }

  /**
   * {@inheritdoc}
   */
  public function hasTranslation($langcode) {
    return $langcode == $this
      ->language()
      ->getId();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
EdgeEntityBase::$decorated	protected	property	The decorated SDK entity.	2
EdgeEntityBase::createFrom	public static	function	Creates a Drupal entity from an SDK Entity. Overrides EdgeEntityInterface::createFrom
EdgeEntityBase::decorated	public	function	Returns the decorated SDK entity. Overrides EdgeEntityInterface::decorated	2
EdgeEntityBase::decoratedClass	abstract protected static	function	The FQCN of the decorated class from the PHP API Client.	5
EdgeEntityBase::drupalEntityId	abstract protected	function	Return the entity id used in Drupal.	4
EdgeEntityBase::getTranslation	public	function
EdgeEntityBase::hasTranslation	public	function
EdgeEntityBase::id	public	function	We have to override this to make it compatible with the SDK's entity interface that enforces the return type. Overrides EntityBase::id	5
EdgeEntityBase::isTranslatable	public	function
EdgeEntityBase::label	public	function	Gets the label of the entity. Overrides EntityBase::label	2
EdgeEntityBase::uniqueIdProperties	public static	function	Returns all unique ids how an entity can be referenced in Apigee Edge. Overrides EdgeEntityInterface::uniqueIdProperties	2
EdgeEntityBase::uniqueIds	public	function	List of unique ids how an entity can be referenced in Apigee Edge. Overrides EdgeEntityInterface::uniqueIds
EdgeEntityBase::__construct	public	function	EdgeEntityBase constructor. Overrides EntityBase::__construct	3
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityInterface::createDuplicate	2
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate	2
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName	1
EntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget	1
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId	1
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::invalidateTagsOnDelete	protected static	function	Invalidates an entity's cache tags upon delete.	1
EntityBase::invalidateTagsOnSave	protected	function	Invalidates an entity's cache tags upon save.	1
EntityBase::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew	2
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link	1
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete	4
EntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave	2
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::save	public	function	Saves an entity permanently. Overrides EntityInterface::save	3
EntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId	1
EntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityInterface::toArray	2
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityInterface::toUrl	2
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityInterface::url	2
EntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo	1
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
EntityBase::__sleep	public	function		2
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function

You are here

abstract class EdgeEntityBase in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation