class DeveloperAppStorage in Apigee Edge 8

Same name in this branch

8 src/Entity/Storage/DeveloperAppStorage.php \Drupal\apigee_edge\Entity\Storage\DeveloperAppStorage
8 tests/modules/apigee_edge_test/src/Entity/Storage/DeveloperAppStorage.php \Drupal\apigee_edge_test\Entity\Storage\DeveloperAppStorage

Entity storage class for Developer app entities.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
  - class \Drupal\apigee_edge\Entity\Storage\EdgeEntityStorageBase implements EdgeEntityStorageInterface
    class \Drupal\apigee_edge\Entity\Storage\FieldableEdgeEntityStorageBase implements FieldableEdgeEntityStorageInterface
    class \Drupal\apigee_edge\Entity\Storage\AttributesAwareFieldableEdgeEntityStorageBase implements AttributesAwareFieldableEdgeEntityStorageInterface
    class \Drupal\apigee_edge\Entity\Storage\AppStorage
    class \Drupal\apigee_edge\Entity\Storage\DeveloperAppStorage implements DeveloperAppStorageInterface

Expanded class hierarchy of DeveloperAppStorage

1 file declares its use of DeveloperAppStorage

DeveloperAppStorage.php in tests/modules/apigee_edge_test/src/Entity/Storage/DeveloperAppStorage.php

File

src/Entity/Storage/DeveloperAppStorage.php, line 39

Namespace

Drupal\apigee_edge\Entity\Storage

View source

class DeveloperAppStorage extends AppStorage implements DeveloperAppStorageInterface {

  /**
   * The app entity controller for unified CRUDL operations.
   *
   * @var \Drupal\apigee_edge\Entity\Controller\EdgeEntityControllerInterface
   */
  private $appEntityController;

  /**
   * The email validator service.
   *
   * @var \Drupal\Component\Utility\EmailValidatorInterface
   */
  private $emailValidator;

  /**
   * DeveloperAppStorage constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend to be used.
   * @param \Drupal\Core\Cache\MemoryCache\MemoryCacheInterface $memory_cache
   *   The memory cache.
   * @param \Drupal\Component\Datetime\TimeInterface $system_time
   *   The system time.
   * @param \Drupal\apigee_edge\Entity\Controller\DeveloperAppControllerFactoryInterface $developer_app_controller_factory
   *   The developer app controller factory service.
   * @param \Drupal\apigee_edge\Entity\Controller\AppControllerInterface $app_controller
   *   The app controller service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
   *   Configuration factory.
   * @param \Drupal\Component\Utility\EmailValidatorInterface $email_validator
   *   The email validator service.
   */
  public function __construct(EntityTypeInterface $entity_type, CacheBackendInterface $cache_backend, MemoryCacheInterface $memory_cache, TimeInterface $system_time, DeveloperAppControllerFactoryInterface $developer_app_controller_factory, AppControllerInterface $app_controller, ConfigFactoryInterface $config, EmailValidatorInterface $email_validator) {
    parent::__construct($entity_type, $cache_backend, $memory_cache, $system_time, $app_controller);
    $this->appEntityController = new DeveloperAppEdgeEntityControllerProxy($developer_app_controller_factory, $app_controller);
    $this->cacheExpiration = $config
      ->get('apigee_edge.developer_app_settings')
      ->get('cache_expiration');
    $this->emailValidator = $email_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('cache.apigee_edge_entity'), $container
      ->get('entity.memory_cache'), $container
      ->get('datetime.time'), $container
      ->get('apigee_edge.controller.developer_app_controller_factory'), $container
      ->get('apigee_edge.controller.app'), $container
      ->get('config.factory'), $container
      ->get('email.validator'));
  }

  /**
   * {@inheritdoc}
   */
  protected function entityController() : EdgeEntityControllerInterface {
    return $this->appEntityController;
  }

  /**
   * {@inheritdoc}
   */
  public function loadByDeveloper(string $developer_id) : array {
    $query = $this
      ->getQuery();

    // We have to figure out whether this is an email or a UUID to call the
    // best API endpoint that is possible.
    if ($this->emailValidator
      ->isValid($developer_id)) {
      $query
        ->condition('email', $developer_id);
    }
    else {
      $query
        ->condition('developerId', $developer_id);
    }
    $ids = $query
      ->execute();
    return $this
      ->loadMultiple(array_values($ids));
  }

  /**
   * {@inheritdoc}
   */
  protected function getCacheTagsByOwner(AppInterface $app) : array {

    // Add developer's UUID to ensure when the owner of the app (developer)
    // gets deleted then _all_ its cached developer app data gets purged along
    // with it.
    $cache_tags = [
      "developer:{$app->getAppOwner()}",
    ];

    /** @var \Drupal\apigee_edge\Entity\DeveloperAppInterface $app */

    // Add the owner of the app (Drupal user id) to ensure when the Drupal user
    // gets deleted then _all_ its cached developer app data gets purged along
    // with it. (The additional cache tag by developer id should be enough
    // though.)
    // Note: This also invalidates cached app data when a user gets updated
    // which might be even beneficial for us. Create a custom solution if this
    // default behavior becomes a bottleneck.
    if ($app
      ->getOwnerId()) {
      $cache_tags[] = "user:{$app->getOwnerId()}";
    }
    return $cache_tags;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AppStorage::$appController	protected	property	The app controller service.
AppStorage::buildCacheIdForAppName	protected	function	Generates a unique cache id for app name.
AppStorage::getCachedAppId	public	function	Returns cached app id for developer id/company name + app name.
AppStorage::getFromStorage	protected	function	Gets entities from the storage. Overrides EdgeEntityStorageBase::getFromStorage
AppStorage::getPersistentCacheTags	final protected	function	Generates cache tags for entities. Overrides FieldableEdgeEntityStorageBase::getPersistentCacheTags
AppStorage::getPersistentCacheTagsForAppName	private	function	Generates cache tags for an app.
AppStorage::initFieldValues	protected	function	Initializes field values. Overrides FieldableEdgeEntityStorageBase::initFieldValues
AppStorage::loadUnchanged	public	function	Loads an unchanged entity from the database. Overrides EdgeEntityStorageBase::loadUnchanged
AppStorage::loadUnchangedByUuid	public	function	Load app by UUID.
AppStorage::resetCache	public	function	Resets the internal, static entity cache. Overrides EdgeEntityStorageBase::resetCache
AppStorage::setPersistentCache	protected	function	Stores entities in the persistent cache backend. Overrides EdgeEntityStorageBase::setPersistentCache
AttributesAwareFieldableEdgeEntityStorageBase::countFieldData	public	function	Determines the number of entities with values for a given field. Overrides FieldableEdgeEntityStorageBase::countFieldData
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		1
DependencySerializationTrait::__wakeup	public	function		2
DeveloperAppStorage::$appEntityController	private	property	The app entity controller for unified CRUDL operations.
DeveloperAppStorage::$emailValidator	private	property	The email validator service.
DeveloperAppStorage::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides AppStorage::createInstance
DeveloperAppStorage::entityController	protected	function	Returns the wrapped controller instance used by this storage. Overrides EdgeEntityStorageBase::entityController
DeveloperAppStorage::getCacheTagsByOwner	protected	function	Returns app owner related cache tags for an app. Overrides AppStorage::getCacheTagsByOwner
DeveloperAppStorage::loadByDeveloper	public	function	Loads developer apps by developer. Overrides DeveloperAppStorageInterface::loadByDeveloper
DeveloperAppStorage::__construct	public	function	DeveloperAppStorage constructor. Overrides AppStorage::__construct
EdgeEntityStorageBase::$cacheBackend	protected	property	Cache backend.
EdgeEntityStorageBase::$cacheExpiration	protected	property	Number of seconds until an entity can be served from cache.
EdgeEntityStorageBase::$systemTime	protected	property	The system time.
EdgeEntityStorageBase::buildCacheId	protected	function	Builds the cache ID for the passed in entity ID. Overrides EntityStorageBase::buildCacheId
EdgeEntityStorageBase::createNewInstance	protected	function	Creates a new Drupal entity from an SDK entity.
EdgeEntityStorageBase::deleteRevision	public	function	Delete a specific entity revision. Overrides EntityStorageInterface::deleteRevision
EdgeEntityStorageBase::doDelete	protected	function	Performs storage-specific entity deletion. Overrides EntityStorageBase::doDelete	1
EdgeEntityStorageBase::doLoadMultiple	protected	function	Performs storage-specific loading of entities. Overrides EntityStorageBase::doLoadMultiple
EdgeEntityStorageBase::doSave	protected	function	Performs storage-specific saving of the entity. Overrides EntityStorageBase::doSave	2
EdgeEntityStorageBase::getFromPersistentCache	protected	function	Gets entities from the persistent cache backend.
EdgeEntityStorageBase::getPersistentCacheExpiration	protected	function	Number of seconds after a cache item expires.
EdgeEntityStorageBase::getQueryServiceName	protected	function	Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase::getQueryServiceName
EdgeEntityStorageBase::has	protected	function	Determines if this entity already exists in storage. Overrides EntityStorageBase::has
EdgeEntityStorageBase::invokeStorageLoadHook	protected	function	Invokes hook_entity_storage_load().
EdgeEntityStorageBase::loadRevision	public	function	Load a specific entity revision. Overrides EntityStorageInterface::loadRevision
EdgeEntityStorageBase::processLoadedEntities	final protected	function	Processes loaded (SDK) entities to Drupal entities.
EdgeEntityStorageBase::resetControllerCache	protected	function	Resets entity controller's cache if it is a cached entity controller.
EdgeEntityStorageBase::SAVED_UNKNOWN	public	constant	Initial status for saving a item to Apigee Edge.
EdgeEntityStorageBase::withController	protected	function	Wraps communication with Apigee Edge.
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityStorageBase::$entityClass	protected	property	Name of the entity class.
EntityStorageBase::$entityType	protected	property	Information about the entity type.
EntityStorageBase::$entityTypeId	protected	property	Entity type ID for this storage.
EntityStorageBase::$idKey	protected	property	Name of the entity's ID field in the entity database table.
EntityStorageBase::$langcodeKey	protected	property	The name of the entity langcode property.	1
EntityStorageBase::$memoryCache	protected	property	The memory cache.
EntityStorageBase::$memoryCacheTag	protected	property	The memory cache cache tag.
EntityStorageBase::$uuidKey	protected	property	Name of entity's UUID database table field, if it supports UUIDs.	1
EntityStorageBase::$uuidService	protected	property	The UUID service.	1
EntityStorageBase::buildPropertyQuery	protected	function	Builds an entity query.	1
EntityStorageBase::create	public	function	Constructs a new entity object, without permanently saving it. Overrides EntityStorageInterface::create	1
EntityStorageBase::delete	public	function	Deletes permanently saved entities. Overrides EntityStorageInterface::delete	2
EntityStorageBase::doPostSave	protected	function	Performs post save entity processing.	1
EntityStorageBase::doPreSave	protected	function	Performs presave entity processing.	1
EntityStorageBase::getAggregateQuery	public	function	Gets an aggregated query instance. Overrides EntityStorageInterface::getAggregateQuery
EntityStorageBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityStorageInterface::getEntityType
EntityStorageBase::getEntityTypeId	public	function	Gets the entity type ID. Overrides EntityStorageInterface::getEntityTypeId
EntityStorageBase::getFromStaticCache	protected	function	Gets entities from the static cache.
EntityStorageBase::getQuery	public	function	Gets an entity query instance. Overrides EntityStorageInterface::getQuery
EntityStorageBase::hasData	public	function	Determines if the storage contains any data. Overrides EntityStorageInterface::hasData	3
EntityStorageBase::invokeHook	protected	function	Invokes a hook on behalf of the entity.	2
EntityStorageBase::load	public	function	Loads one entity. Overrides EntityStorageInterface::load	2
EntityStorageBase::loadByProperties	public	function	Load entities by their property values. Overrides EntityStorageInterface::loadByProperties	3
EntityStorageBase::loadMultiple	public	function	Loads one or more entities. Overrides EntityStorageInterface::loadMultiple	1
EntityStorageBase::mapFromStorageRecords	protected	function	Maps from storage records to entity objects.	4
EntityStorageBase::postLoad	protected	function	Attaches data to entities upon loading.
EntityStorageBase::preLoad	protected	function	Gathers entities from a 'preload' step.	1
EntityStorageBase::restore	public	function	Restores a previously saved entity. Overrides EntityStorageInterface::restore	1
EntityStorageBase::save	public	function	Saves the entity permanently. Overrides EntityStorageInterface::save	4
EntityStorageBase::setStaticCache	protected	function	Stores entities in the static entity cache.
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
FieldableEdgeEntityStorageBase::doCreate	protected	function	Overrides EntityStorageBase::doCreate
FieldableEdgeEntityStorageBase::finalizePurge	public	function	Performs final cleanup after all data of a field has been purged. Overrides FieldableEntityStorageInterface::finalizePurge
FieldableEdgeEntityStorageBase::onEntityTypeCreate	public	function	Reacts to the creation of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeCreate
FieldableEdgeEntityStorageBase::onEntityTypeDelete	public	function	Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeDelete
FieldableEdgeEntityStorageBase::onEntityTypeUpdate	public	function	Reacts to the update of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeUpdate
FieldableEdgeEntityStorageBase::onFieldableEntityTypeCreate	public	function	Reacts to the creation of the fieldable entity type. Overrides EntityTypeListenerInterface::onFieldableEntityTypeCreate
FieldableEdgeEntityStorageBase::onFieldableEntityTypeUpdate	public	function	Reacts to the update of a fieldable entity type. Overrides EntityTypeListenerInterface::onFieldableEntityTypeUpdate
FieldableEdgeEntityStorageBase::onFieldDefinitionCreate	public	function	Reacts to the creation of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionCreate
FieldableEdgeEntityStorageBase::onFieldDefinitionDelete	public	function	Reacts to the deletion of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionDelete
FieldableEdgeEntityStorageBase::onFieldDefinitionUpdate	public	function	Reacts to the update of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionUpdate
FieldableEdgeEntityStorageBase::onFieldStorageDefinitionCreate	public	function	Reacts to the creation of a field storage definition. Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionCreate
FieldableEdgeEntityStorageBase::onFieldStorageDefinitionDelete	public	function	Reacts to the deletion of a field storage definition. Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionDelete
FieldableEdgeEntityStorageBase::onFieldStorageDefinitionUpdate	public	function	Reacts to the update of a field storage definition. Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionUpdate
FieldableEdgeEntityStorageBase::purgeFieldData	public	function	Purges a batch of field data. Overrides FieldableEntityStorageInterface::purgeFieldData
FieldableEdgeEntityStorageBase::requiresEntityDataMigration	public	function	Checks if existing data would be lost if the schema changes were applied. Overrides EntityStorageSchemaInterface::requiresEntityDataMigration
FieldableEdgeEntityStorageBase::requiresEntityStorageSchemaChanges	public	function	Checks if the changes to the entity type requires storage schema changes. Overrides EntityStorageSchemaInterface::requiresEntityStorageSchemaChanges
FieldableEdgeEntityStorageBase::requiresFieldDataMigration	public	function	Checks if existing data would be lost if the schema changes were applied. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldDataMigration
FieldableEdgeEntityStorageBase::requiresFieldStorageSchemaChanges	public	function	Checks if the changes to the storage definition requires schema changes. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldStorageSchemaChanges
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class DeveloperAppStorage in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation