class FieldConfigStorageBase

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldConfigStorageBase.php \Drupal\Core\Field\FieldConfigStorageBase
  2. 8.9.x core/lib/Drupal/Core/Field/FieldConfigStorageBase.php \Drupal\Core\Field\FieldConfigStorageBase
  3. 10 core/lib/Drupal/Core/Field/FieldConfigStorageBase.php \Drupal\Core\Field\FieldConfigStorageBase

Base storage class for field config entities.

Hierarchy

Expanded class hierarchy of FieldConfigStorageBase

1 file declares its use of FieldConfigStorageBase
FieldConfigStorage.php in core/modules/field/src/FieldConfigStorage.php

File

core/lib/Drupal/Core/Field/FieldConfigStorageBase.php, line 12

Namespace

Drupal\Core\Field
View source
abstract class FieldConfigStorageBase extends ConfigEntityStorage {
    
    /**
     * The field type plugin manager.
     *
     * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
     */
    protected $fieldTypeManager;
    
    /**
     * {@inheritdoc}
     */
    protected function mapFromStorageRecords(array $records) {
        foreach ($records as $id => &$record) {
            try {
                $class = $this->fieldTypeManager
                    ->getPluginClass($record['field_type']);
            } catch (PluginNotFoundException $e) {
                $config_id = $this->getPrefix() . $id;
                throw new PluginNotFoundException($record['field_type'], "Unable to determine class for field type '{$record['field_type']}' found in the '{$config_id}' configuration", $e->getCode(), $e);
            }
            $record['settings'] = $class::fieldSettingsFromConfigData($record['settings']);
        }
        return parent::mapFromStorageRecords($records);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function mapToStorageRecord(EntityInterface $entity) {
        $record = parent::mapToStorageRecord($entity);
        $class = $this->fieldTypeManager
            ->getPluginClass($record['field_type']);
        $record['settings'] = $class::fieldSettingsToConfigData($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 Overrides EntityStorageBase::$uuidKey
ConfigEntityStorage::buildCacheId protected function Overrides EntityStorageBase::buildCacheId
ConfigEntityStorage::createFromStorageRecord public function Overrides ConfigEntityStorageInterface::createFromStorageRecord
ConfigEntityStorage::createInstance public static function Overrides EntityHandlerInterface::createInstance 4
ConfigEntityStorage::doCreate protected function Overrides EntityStorageBase::doCreate
ConfigEntityStorage::doDelete protected function Overrides EntityStorageBase::doDelete
ConfigEntityStorage::doLoadMultiple protected function Overrides EntityStorageBase::doLoadMultiple
ConfigEntityStorage::doSave protected function Overrides EntityStorageBase::doSave
ConfigEntityStorage::getIDFromConfigName public static function Overrides ConfigEntityStorageInterface::getIDFromConfigName
ConfigEntityStorage::getPrefix protected function Returns the prefix used to create the configuration name.
ConfigEntityStorage::getQueryServiceName protected function Overrides EntityStorageBase::getQueryServiceName
ConfigEntityStorage::has protected function Overrides EntityStorageBase::has
ConfigEntityStorage::hasData public function Overrides EntityStorageBase::hasData
ConfigEntityStorage::importCreate public function Overrides ImportableEntityStorageInterface::importCreate 1
ConfigEntityStorage::importDelete public function Overrides ImportableEntityStorageInterface::importDelete 2
ConfigEntityStorage::importRename public function Overrides ImportableEntityStorageInterface::importRename
ConfigEntityStorage::importUpdate public function Overrides ImportableEntityStorageInterface::importUpdate 1
ConfigEntityStorage::invokeHook protected function Invokes a hook on behalf of the entity. Overrides EntityStorageBase::invokeHook
ConfigEntityStorage::loadMultipleOverrideFree public function Overrides ConfigEntityStorageInterface::loadMultipleOverrideFree
ConfigEntityStorage::loadOverrideFree public function 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 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 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
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 Overrides EntityStorageInterface::create 1
EntityStorageBase::delete public function 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 Overrides EntityStorageInterface::getAggregateQuery
EntityStorageBase::getEntitiesByClass protected function Indexes the given array of entities by their class name and ID.
EntityStorageBase::getEntityClass public function Overrides EntityStorageInterface::getEntityClass 1
EntityStorageBase::getEntityType public function Overrides EntityStorageInterface::getEntityType
EntityStorageBase::getEntityTypeId public function Overrides EntityStorageInterface::getEntityTypeId
EntityStorageBase::getFromStaticCache protected function Gets entities from the static cache.
EntityStorageBase::getQuery public function Overrides EntityStorageInterface::getQuery
EntityStorageBase::load public function Overrides EntityStorageInterface::load 2
EntityStorageBase::loadByProperties public function Overrides EntityStorageInterface::loadByProperties 3
EntityStorageBase::loadMultiple public function Overrides EntityStorageInterface::loadMultiple 1
EntityStorageBase::loadUnchanged public function 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 Overrides EntityStorageInterface::resetCache 1
EntityStorageBase::restore public function 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.
FieldConfigStorageBase::$fieldTypeManager protected property The field type plugin manager. 1
FieldConfigStorageBase::mapFromStorageRecords protected function Overrides EntityStorageBase::mapFromStorageRecords
FieldConfigStorageBase::mapToStorageRecord protected function Overrides ConfigEntityStorage::mapToStorageRecord
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.