class FieldStorageConfigStorage
Same name in other branches
- 9 core/modules/field/src/FieldStorageConfigStorage.php \Drupal\field\FieldStorageConfigStorage
- 8.9.x core/modules/field/src/FieldStorageConfigStorage.php \Drupal\field\FieldStorageConfigStorage
- 10 core/modules/field/src/FieldStorageConfigStorage.php \Drupal\field\FieldStorageConfigStorage
Storage handler for "field storage" configuration entities.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityStorageBase extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface
- class \Drupal\Core\Config\Entity\ConfigEntityStorage extends \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Config\Entity\ConfigEntityStorageInterface, \Drupal\Core\Config\Entity\ImportableEntityStorageInterface
- class \Drupal\field\FieldStorageConfigStorage extends \Drupal\Core\Config\Entity\ConfigEntityStorage
- class \Drupal\Core\Config\Entity\ConfigEntityStorage extends \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Config\Entity\ConfigEntityStorageInterface, \Drupal\Core\Config\Entity\ImportableEntityStorageInterface
- class \Drupal\Core\Entity\EntityStorageBase extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface
Expanded class hierarchy of FieldStorageConfigStorage
File
-
core/
modules/ field/ src/ FieldStorageConfigStorage.php, line 22
Namespace
Drupal\fieldView source
class FieldStorageConfigStorage extends ConfigEntityStorage {
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The field type plugin manager.
*
* @var \Drupal\Core\Field\FieldTypePluginManagerInterface
*/
protected $fieldTypeManager;
/**
* The deleted fields repository.
*
* @var \Drupal\Core\Field\DeletedFieldsRepositoryInterface
*/
protected $deletedFieldsRepository;
/**
* Constructs a FieldStorageConfigStorage object.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory service.
* @param \Drupal\Component\Uuid\UuidInterface $uuid_service
* The UUID service.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
* The field type plugin manager.
* @param \Drupal\Core\Field\DeletedFieldsRepositoryInterface $deleted_fields_repository
* The deleted fields repository.
* @param \Drupal\Core\Cache\MemoryCache\MemoryCacheInterface $memory_cache
* The memory cache.
*/
public function __construct(EntityTypeInterface $entity_type, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, FieldTypePluginManagerInterface $field_type_manager, DeletedFieldsRepositoryInterface $deleted_fields_repository, MemoryCacheInterface $memory_cache) {
parent::__construct($entity_type, $config_factory, $uuid_service, $language_manager, $memory_cache);
$this->entityTypeManager = $entity_type_manager;
$this->moduleHandler = $module_handler;
$this->fieldTypeManager = $field_type_manager;
$this->deletedFieldsRepository = $deleted_fields_repository;
}
/**
* {@inheritdoc}
*/
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
return new static($entity_type, $container->get('config.factory'), $container->get('uuid'), $container->get('language_manager'), $container->get('entity_type.manager'), $container->get('module_handler'), $container->get('plugin.manager.field.field_type'), $container->get('entity_field.deleted_fields_repository'), $container->get('entity.memory_cache'));
}
/**
* {@inheritdoc}
*/
public function loadByProperties(array $conditions = []) {
// Include deleted fields if specified in the $conditions parameters.
$include_deleted = $conditions['include_deleted'] ?? FALSE;
unset($conditions['include_deleted']);
/** @var \Drupal\field\FieldStorageConfigInterface[] $storages */
$storages = [];
// Get field storages living in configuration. If we are explicitly looking
// for deleted storages only, this can be skipped, because they will be
// retrieved from the deleted fields repository below.
if (empty($conditions['deleted'])) {
if (isset($conditions['entity_type']) && isset($conditions['field_name'])) {
// Optimize for the most frequent case where we do have a specific ID.
$id = $conditions['entity_type'] . '.' . $conditions['field_name'];
$storages = $this->loadMultiple([
$id,
]);
}
else {
// No specific ID, we need to examine all existing storages.
$storages = $this->loadMultiple();
}
}
// Merge deleted field storage definitions from the deleted fields
// repository if needed.
if ($include_deleted || !empty($conditions['deleted'])) {
$deleted_storage_definitions = $this->deletedFieldsRepository
->getFieldStorageDefinitions();
foreach ($deleted_storage_definitions as $id => $field_storage_definition) {
if ($field_storage_definition instanceof FieldStorageConfigInterface) {
$storages[$id] = $field_storage_definition;
}
}
}
// Collect matching fields.
$matches = [];
foreach ($storages as $field) {
foreach ($conditions as $key => $value) {
// Extract the actual value against which the condition is checked.
$checked_value = $field->get($key);
// Skip to the next field as soon as one condition does not match.
if ($checked_value != $value) {
continue 2;
}
}
// When returning deleted fields, key the results by UUID since they can
// include several fields with the same ID.
$key = $include_deleted ? $field->uuid() : $field->id();
$matches[$key] = $field;
}
return $matches;
}
/**
* {@inheritdoc}
*/
protected function mapFromStorageRecords(array $records) {
foreach ($records as $id => &$record) {
try {
$class = $this->fieldTypeManager
->getPluginClass($record['type']);
} catch (PluginNotFoundException $e) {
$config_id = $this->getPrefix() . $id;
throw new PluginNotFoundException($record['type'], "Unable to determine class for field type '{$record['type']}' found in the '{$config_id}' configuration", $e->getCode(), $e);
}
$record['settings'] = $class::storageSettingsFromConfigData($record['settings']);
}
return parent::mapFromStorageRecords($records);
}
/**
* {@inheritdoc}
*/
protected function mapToStorageRecord(EntityInterface $entity) {
$record = parent::mapToStorageRecord($entity);
$class = $this->fieldTypeManager
->getPluginClass($record['type']);
$record['settings'] = $class::storageSettingsToConfigData($record['settings']);
return $record;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigEntityStorage::$configFactory | protected | property | The config factory service. | ||
ConfigEntityStorage::$configStorage | protected | property | The config storage service. | ||
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::buildCacheId | protected | function | Builds the cache ID for the passed in entity ID. | Overrides EntityStorageBase::buildCacheId | |
ConfigEntityStorage::createFromStorageRecord | public | function | Creates a configuration entity from storage values. | Overrides ConfigEntityStorageInterface::createFromStorageRecord | |
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::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::hasData | public | function | Determines if the storage contains any data. | Overrides EntityStorageBase::hasData | |
ConfigEntityStorage::importCreate | public | function | Creates entities upon synchronizing configuration changes. | Overrides ImportableEntityStorageInterface::importCreate | 1 |
ConfigEntityStorage::importDelete | public | function | Delete entities upon synchronizing configuration changes. | Overrides ImportableEntityStorageInterface::importDelete | 2 |
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 | 1 |
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::MAX_ID_LENGTH | constant | Length limit of the configuration entity ID. | 1 | ||
ConfigEntityStorage::save | public | function | Implements Drupal\Core\Entity\EntityStorageInterface::save(). | Overrides EntityStorageBase::save | |
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. | ||
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
EntityHandlerBase::moduleHandler | protected | function | Gets the module handler. | 5 | |
EntityHandlerBase::setModuleHandler | public | function | Sets the module handler for this handler. | ||
EntityStorageBase::$baseEntityClass | private | property | Name of the base 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 tag. | ||
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::getEntitiesByClass | protected | function | Indexes the given array of entities by their class name and ID. | ||
EntityStorageBase::getEntityClass | public | function | Retrieves the class name used to create the entity. | Overrides EntityStorageInterface::getEntityClass | 1 |
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 | 2 |
EntityStorageBase::loadMultiple | public | function | Loads one or more entities. | Overrides EntityStorageInterface::loadMultiple | 1 |
EntityStorageBase::loadUnchanged | public | function | Loads an unchanged entity from the database. | Overrides EntityStorageInterface::loadUnchanged | 1 |
EntityStorageBase::postLoad | protected | function | Attaches data to entities upon loading. | ||
EntityStorageBase::preLoad | protected | function | Gathers entities from a 'preload' step. | 1 | |
EntityStorageBase::resetCache | public | function | Resets the internal entity cache. | Overrides EntityStorageInterface::resetCache | 1 |
EntityStorageBase::restore | public | function | Restores a previously saved entity. | Overrides EntityStorageInterface::restore | 1 |
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. | |||
FieldStorageConfigStorage::$deletedFieldsRepository | protected | property | The deleted fields repository. | ||
FieldStorageConfigStorage::$entityTypeManager | protected | property | The entity type manager. | ||
FieldStorageConfigStorage::$fieldTypeManager | protected | property | The field type plugin manager. | ||
FieldStorageConfigStorage::$moduleHandler | protected | property | The module handler. | Overrides EntityHandlerBase::$moduleHandler | |
FieldStorageConfigStorage::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides ConfigEntityStorage::createInstance | |
FieldStorageConfigStorage::loadByProperties | public | function | Load entities by their property values without any access checks. | Overrides EntityStorageBase::loadByProperties | |
FieldStorageConfigStorage::mapFromStorageRecords | protected | function | Maps from storage records to entity objects. | Overrides EntityStorageBase::mapFromStorageRecords | |
FieldStorageConfigStorage::mapToStorageRecord | protected | function | Maps from an entity object to the storage record. | Overrides ConfigEntityStorage::mapToStorageRecord | |
FieldStorageConfigStorage::__construct | public | function | Constructs a FieldStorageConfigStorage object. | Overrides ConfigEntityStorage::__construct | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.