SqlContentEntityStorage

A content entity database storage implementation.

This class can be used as-is by most content entity types. Entity types requiring special handling can extend the class.

The class uses \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema internally in order to automatically generate the database schema based on the defined base fields. Entity types can override the schema handler to customize the generated schema; e.g., to add additional indexes.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
  - class \Drupal\Core\Entity\ContentEntityStorageBase implements ContentEntityStorageInterface, DynamicallyFieldableEntityStorageInterface
    - class \Drupal\Core\Entity\Sql\SqlContentEntityStorage implements EntityBundleListenerInterface, DynamicallyFieldableEntityStorageSchemaInterface, SqlEntityStorageInterface

File

core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php, line 39

Namespace

Drupal\Core\Entity\Sql

Members

Name	Modifiers	Type	Description
ContentEntityStorageBase::$bundleKey	protected	property	The entity bundle key.
ContentEntityStorageBase::$cacheBackend	protected	property	Cache backend.
ContentEntityStorageBase::$entityManager	protected	property	The entity manager.
ContentEntityStorageBase::buildCacheId	protected	function	Builds the cache ID for the passed in entity ID.
ContentEntityStorageBase::cleanIds	protected	function	Ensures integer entity IDs are valid.
ContentEntityStorageBase::createTranslation	public	function	Constructs a new entity translation object, without permanently saving it. Overrides ContentEntityStorageInterface::createTranslation
ContentEntityStorageBase::deleteRevision	public	function	Delete a specific entity revision. Overrides EntityStorageInterface::deleteRevision
ContentEntityStorageBase::doCreate	protected	function	Performs storage-specific creation of entities. Overrides EntityStorageBase::doCreate
ContentEntityStorageBase::doDelete	protected	function	Performs storage-specific entity deletion. Overrides EntityStorageBase::doDelete
ContentEntityStorageBase::doPostSave	protected	function	Performs post save entity processing. Overrides EntityStorageBase::doPostSave
ContentEntityStorageBase::doPreSave	protected	function	Performs presave entity processing. Overrides EntityStorageBase::doPreSave
ContentEntityStorageBase::doSave	protected	function	Performs storage-specific saving of the entity. Overrides EntityStorageBase::doSave
ContentEntityStorageBase::getFromPersistentCache	protected	function	Gets entities from the persistent cache backend.
ContentEntityStorageBase::hasData	public	function	Determines if the storage contains any data. Overrides DynamicallyFieldableEntityStorageInterface::hasData
ContentEntityStorageBase::hasFieldValueChanged	protected	function	Checks whether the field values changed compared to the original entity.
ContentEntityStorageBase::initFieldValues	protected	function	Initializes field values.
ContentEntityStorageBase::invokeFieldMethod	protected	function	Invokes a method on the Field objects within an entity.
ContentEntityStorageBase::invokeFieldPostSave	protected	function	Invokes the post save method on the Field objects within an entity.
ContentEntityStorageBase::invokeHook	protected	function	Invokes a hook on behalf of the entity. Overrides EntityStorageBase::invokeHook
ContentEntityStorageBase::invokeStorageLoadHook	protected	function	Invokes hook_entity_storage_load().
ContentEntityStorageBase::invokeTranslationHooks	protected	function	Checks translation statuses and invoke the related hooks if needed.
ContentEntityStorageBase::loadRevision	public	function	Load a specific entity revision. Overrides EntityStorageInterface::loadRevision
ContentEntityStorageBase::onFieldDefinitionCreate	public	function	Reacts to the creation of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionCreate
ContentEntityStorageBase::onFieldDefinitionUpdate	public	function	Reacts to the update of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionUpdate
ContentEntityStorageBase::populateAffectedRevisionTranslations	protected	function	Populates the affected flag for all the revision translations.
ContentEntityStorageBase::purgeFieldData	public	function	Purges a batch of field data. Overrides DynamicallyFieldableEntityStorageInterface::purgeFieldData
ContentEntityStorageBase::resetCache	public	function	Resets the internal, static entity cache. Overrides EntityStorageBase::resetCache
ContentEntityStorageBase::setPersistentCache	protected	function	Stores entities in the persistent cache backend.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
DependencySerializationTrait::__wakeup	public	function
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityStorageBase::$entities	protected	property	Static cache of entities, keyed by entity ID.
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::$uuidKey	protected	property	Name of entity's UUID database table field, if it supports UUIDs.
EntityStorageBase::$uuidService	protected	property	The UUID service.
EntityStorageBase::create	public	function	Constructs a new entity object, without permanently saving it. Overrides EntityStorageInterface::create
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::load	public	function	Loads one entity. Overrides EntityStorageInterface::load
EntityStorageBase::loadByProperties	public	function	Load entities by their property values. Overrides EntityStorageInterface::loadByProperties
EntityStorageBase::loadMultiple	public	function	Loads one or more entities. Overrides EntityStorageInterface::loadMultiple
EntityStorageBase::loadUnchanged	public	function	Loads an unchanged entity from the database. Overrides EntityStorageInterface::loadUnchanged
EntityStorageBase::postLoad	protected	function	Attaches data to entities upon loading.
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. Overrides EntityStorageInterface::FIELD_LOAD_CURRENT
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity. Overrides EntityStorageInterface::FIELD_LOAD_REVISION
SqlContentEntityStorage::$baseTable	protected	property	The base table of the entity.
SqlContentEntityStorage::$database	protected	property	Active database connection.
SqlContentEntityStorage::$dataTable	protected	property	The table that stores properties, if the entity has multilingual support.
SqlContentEntityStorage::$defaultLangcodeKey	protected	property	The default language entity key.
SqlContentEntityStorage::$langcodeKey	protected	property	The entity langcode key. Overrides EntityStorageBase::$langcodeKey
SqlContentEntityStorage::$languageManager	protected	property	The language manager.
SqlContentEntityStorage::$revisionDataTable	protected	property	The table that stores revision field data if the entity supports revisions.
SqlContentEntityStorage::$revisionKey	protected	property	Name of entity's revision database table field, if it supports revisions.
SqlContentEntityStorage::$revisionTable	protected	property	The table that stores revisions, if the entity supports revisions.
SqlContentEntityStorage::$storageSchema	protected	property	The entity type's storage schema object.
SqlContentEntityStorage::$tableMapping	protected	property	The mapping of field columns to SQL tables.
SqlContentEntityStorage::buildPropertyQuery	protected	function	Builds an entity query. Overrides EntityStorageBase::buildPropertyQuery
SqlContentEntityStorage::buildQuery	protected	function	Builds the query to load the entity.
SqlContentEntityStorage::countFieldData	public	function	Determines the number of entities with values for a given field. Overrides FieldableEntityStorageInterface::countFieldData
SqlContentEntityStorage::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides ContentEntityStorageBase::createInstance
SqlContentEntityStorage::delete	public	function	Deletes permanently saved entities. Overrides EntityStorageBase::delete
SqlContentEntityStorage::deleteFromDedicatedTables	protected	function	Deletes values of fields in dedicated tables for all revisions.
SqlContentEntityStorage::deleteRevisionFromDedicatedTables	protected	function	Deletes values of fields in dedicated tables for all revisions.
SqlContentEntityStorage::doDeleteFieldItems	protected	function	Deletes entity field values from the storage. Overrides ContentEntityStorageBase::doDeleteFieldItems
SqlContentEntityStorage::doDeleteRevisionFieldItems	protected	function	Deletes field values of an entity revision from the storage. Overrides ContentEntityStorageBase::doDeleteRevisionFieldItems
SqlContentEntityStorage::doLoadMultiple	protected	function	Performs storage-specific loading of entities. Overrides EntityStorageBase::doLoadMultiple
SqlContentEntityStorage::doLoadRevisionFieldItems	protected	function	Actually loads revision field item values from the storage. Overrides ContentEntityStorageBase::doLoadRevisionFieldItems
SqlContentEntityStorage::doSaveFieldItems	protected	function	Writes entity field values to the storage. Overrides ContentEntityStorageBase::doSaveFieldItems
SqlContentEntityStorage::finalizePurge	public	function	Performs final cleanup after all data of a field has been purged. Overrides ContentEntityStorageBase::finalizePurge
SqlContentEntityStorage::getBaseTable	public	function	Gets the base table name.
SqlContentEntityStorage::getDataTable	public	function	Gets the data table name.
SqlContentEntityStorage::getFieldStorageDefinitions	public	function	Gets the base field definitions for a content entity type.
SqlContentEntityStorage::getFromStorage	protected	function	Gets entities from the storage.
SqlContentEntityStorage::getQueryServiceName	protected	function	Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase::getQueryServiceName
SqlContentEntityStorage::getRevisionDataTable	public	function	Gets the revision data table name.
SqlContentEntityStorage::getRevisionTable	public	function	Gets the revision table name.
SqlContentEntityStorage::getStorageSchema	protected	function	Gets the entity type's storage schema object.
SqlContentEntityStorage::getTableMapping	public	function	Gets a table mapping for the entity's SQL tables. Overrides SqlEntityStorageInterface::getTableMapping
SqlContentEntityStorage::has	protected	function	Determines if this entity already exists in storage. Overrides EntityStorageBase::has
SqlContentEntityStorage::initTableLayout	protected	function	Initializes table name variables.
SqlContentEntityStorage::isColumnSerial	protected	function	Checks whether a field column should be treated as serial.
SqlContentEntityStorage::loadFromDedicatedTables	protected	function	Loads values of fields stored in dedicated tables for a group of entities.
SqlContentEntityStorage::loadFromSharedTables	protected	function	Loads values for fields stored in the shared data tables.
SqlContentEntityStorage::mapFromStorageRecords	protected	function	Maps from storage records to entity objects, and attaches fields. Overrides EntityStorageBase::mapFromStorageRecords
SqlContentEntityStorage::mapToDataStorageRecord	protected	function	Maps from an entity object to the storage record of the field data.
SqlContentEntityStorage::mapToStorageRecord	protected	function	Maps from an entity object to the storage record.
SqlContentEntityStorage::onBundleCreate	public	function	Reacts to a bundle being created. Overrides EntityBundleListenerInterface::onBundleCreate
SqlContentEntityStorage::onBundleDelete	public	function	Reacts to a bundle being deleted. Overrides EntityBundleListenerInterface::onBundleDelete
SqlContentEntityStorage::onEntityTypeCreate	public	function	Reacts to the creation of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeCreate
SqlContentEntityStorage::onEntityTypeDelete	public	function	Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeDelete
SqlContentEntityStorage::onEntityTypeUpdate	public	function	Reacts to the update of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeUpdate
SqlContentEntityStorage::onFieldDefinitionDelete	public	function	Reacts to the deletion of a field. Overrides ContentEntityStorageBase::onFieldDefinitionDelete
SqlContentEntityStorage::onFieldStorageDefinitionCreate	public	function	Reacts to the creation of a field storage definition. Overrides ContentEntityStorageBase::onFieldStorageDefinitionCreate
SqlContentEntityStorage::onFieldStorageDefinitionDelete	public	function	Reacts to the deletion of a field storage definition. Overrides ContentEntityStorageBase::onFieldStorageDefinitionDelete
SqlContentEntityStorage::onFieldStorageDefinitionUpdate	public	function	Reacts to the update of a field storage definition. Overrides ContentEntityStorageBase::onFieldStorageDefinitionUpdate
SqlContentEntityStorage::purgeFieldItems	protected	function	Removes field items from storage per entity during purge. Overrides ContentEntityStorageBase::purgeFieldItems
SqlContentEntityStorage::readFieldItemsToPurge	protected	function	Reads values to be purged for a single field. Overrides ContentEntityStorageBase::readFieldItemsToPurge
SqlContentEntityStorage::requiresEntityDataMigration	public	function	Checks if existing data would be lost if the schema changes were applied. Overrides EntityStorageSchemaInterface::requiresEntityDataMigration
SqlContentEntityStorage::requiresEntityStorageSchemaChanges	public	function	Checks if the changes to the entity type requires storage schema changes. Overrides EntityStorageSchemaInterface::requiresEntityStorageSchemaChanges
SqlContentEntityStorage::requiresFieldDataMigration	public	function	Checks if existing data would be lost if the schema changes were applied. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldDataMigration
SqlContentEntityStorage::requiresFieldStorageSchemaChanges	public	function	Checks if the changes to the storage definition requires schema changes. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldStorageSchemaChanges
SqlContentEntityStorage::save	public	function	Saves the entity permanently. Overrides EntityStorageBase::save
SqlContentEntityStorage::saveRevision	protected	function	Saves an entity revision.
SqlContentEntityStorage::saveToDedicatedTables	protected	function	Saves values of fields that use dedicated tables.
SqlContentEntityStorage::saveToSharedTables	protected	function	Saves fields that use the shared tables.
SqlContentEntityStorage::setEntityType	public	function	Updates the wrapped entity type definition.
SqlContentEntityStorage::storageDefinitionIsDeleted	protected	function	Determines whether the passed field has been already deleted.
SqlContentEntityStorage::wrapSchemaException	protected	function	Wraps a database schema exception into an entity storage exception.
SqlContentEntityStorage::__construct	public	function	Constructs a SqlContentEntityStorage object. Overrides ContentEntityStorageBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21Sql%21SqlContentEntityStorage.php/class/SqlContentEntityStorage/8.2.x

doc_Drupal

2016-10-29 09:43:18

Comments

SqlContentEntityStorage

Hierarchy

Related topics

File

Namespace

Members