ConfigEntityStorage

Defines the storage class for configuration entities.

Configuration object names of configuration entities are comprised of two parts, separated by a dot:

config_prefix: A string denoting the owner (module/extension) of the configuration object, followed by arbitrary other namespace identifiers that are declared by the owning extension; e.g., 'node.type'. The config_prefix does NOT contain a trailing dot. It is defined by the entity type's annotation.
ID: A string denoting the entity ID within the entity type namespace; e.g., 'article'. Entity IDs may contain dots/periods. The entire remaining string after the config_prefix in a config name forms the entity ID. Additional or custom suffixes are not possible.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
  - class \Drupal\Core\Config\Entity\ConfigEntityStorage implements ConfigEntityStorageInterface, ImportableEntityStorageInterface

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityStorage.php, line 35

Namespace

Drupal\Core\Config\Entity

Members

Name	Modifiers	Type	Description
ConfigEntityStorage::$configFactory	protected	property	The config factory service.
ConfigEntityStorage::$configStorage	protected	property	The config storage service.
ConfigEntityStorage::$entities	protected	property	Static cache of entities, keyed first by entity ID, then by an extra key. Overrides EntityStorageBase::$entities
ConfigEntityStorage::$languageManager	protected	property	The language manager.
ConfigEntityStorage::$overrideFree	protected	property	Determines if the underlying configuration is retrieved override free.
ConfigEntityStorage::$uuidKey	protected	property	Name of entity's UUID database table field, if it supports UUIDs. Overrides EntityStorageBase::$uuidKey
ConfigEntityStorage::createFromStorageRecord	public	function	Creates a configuration entity from storage values. Overrides ConfigEntityStorageInterface::createFromStorageRecord
ConfigEntityStorage::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
ConfigEntityStorage::deleteRevision	public	function	Delete a specific entity revision. Overrides EntityStorageInterface::deleteRevision
ConfigEntityStorage::doCreate	protected	function	Performs storage-specific creation of entities. Overrides EntityStorageBase::doCreate
ConfigEntityStorage::doDelete	protected	function	Performs storage-specific entity deletion. Overrides EntityStorageBase::doDelete
ConfigEntityStorage::doLoadMultiple	protected	function	Performs storage-specific loading of entities. Overrides EntityStorageBase::doLoadMultiple
ConfigEntityStorage::doSave	protected	function	Performs storage-specific saving of the entity. Overrides EntityStorageBase::doSave
ConfigEntityStorage::getFromStaticCache	protected	function	Gets entities from the static cache. Overrides EntityStorageBase::getFromStaticCache
ConfigEntityStorage::getIDFromConfigName	public static	function	Extracts the configuration entity ID from the full configuration name. Overrides ConfigEntityStorageInterface::getIDFromConfigName
ConfigEntityStorage::getPrefix	protected	function	Returns the prefix used to create the configuration name.
ConfigEntityStorage::getQueryServiceName	protected	function	Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase::getQueryServiceName
ConfigEntityStorage::has	protected	function	Determines if this entity already exists in storage. Overrides EntityStorageBase::has
ConfigEntityStorage::importCreate	public	function	Creates entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importCreate
ConfigEntityStorage::importDelete	public	function	Delete entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importDelete
ConfigEntityStorage::importRename	public	function	Renames entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importRename
ConfigEntityStorage::importUpdate	public	function	Updates entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importUpdate
ConfigEntityStorage::invokeHook	protected	function	Invokes a hook on behalf of the entity. Overrides EntityStorageBase::invokeHook
ConfigEntityStorage::loadMultipleOverrideFree	public	function	Loads one or more entities in their original form without overrides. Overrides ConfigEntityStorageInterface::loadMultipleOverrideFree
ConfigEntityStorage::loadOverrideFree	public	function	Loads one entity in their original form without overrides. Overrides ConfigEntityStorageInterface::loadOverrideFree
ConfigEntityStorage::loadRevision	public	function	Load a specific entity revision. Overrides EntityStorageInterface::loadRevision
ConfigEntityStorage::mapToStorageRecord	protected	function	Maps from an entity object to the storage record.
ConfigEntityStorage::MAX_ID_LENGTH		constant	Length limit of the configuration entity ID.
ConfigEntityStorage::save	public	function	Implements Drupal\Core\Entity\EntityStorageInterface::save(). Overrides EntityStorageBase::save
ConfigEntityStorage::setStaticCache	protected	function	Stores entities in the static entity cache. Overrides EntityStorageBase::setStaticCache
ConfigEntityStorage::updateFromStorageRecord	public	function	Updates a configuration entity from storage values. Overrides ConfigEntityStorageInterface::updateFromStorageRecord
ConfigEntityStorage::_doCreateFromStorageRecord	protected	function	Helps create a configuration entity from storage values.
ConfigEntityStorage::__construct	public	function	Constructs a ConfigEntityStorage object. Overrides EntityStorageBase::__construct
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::$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.
EntityStorageBase::$uuidService	protected	property	The UUID service.
EntityStorageBase::buildPropertyQuery	protected	function	Builds an entity query.
EntityStorageBase::create	public	function	Constructs a new entity object, without permanently saving it. Overrides EntityStorageInterface::create
EntityStorageBase::delete	public	function	Deletes permanently saved entities. Overrides EntityStorageInterface::delete
EntityStorageBase::doPostSave	protected	function	Performs post save entity processing.
EntityStorageBase::doPreSave	protected	function	Performs presave entity processing.
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::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::mapFromStorageRecords	protected	function	Maps from storage records to entity objects.
EntityStorageBase::postLoad	protected	function	Attaches data to entities upon loading.
EntityStorageBase::resetCache	public	function	Resets the internal, static entity cache. Overrides EntityStorageInterface::resetCache
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
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%21Config%21Entity%21ConfigEntityStorage.php/class/ConfigEntityStorage/8.2.x

doc_Drupal

2016-10-29 08:52:51

Comments

ConfigEntityStorage

Hierarchy

Related topics

File

Namespace

Members