Edit
In Place Editing Advanced Editing

FieldStorageConfig

Defines the Field storage configuration entity.

Plugin annotation

@ConfigEntityType(
  id = "field_storage_config",
  label = @Translation("Field storage"),
  handlers = {
    "storage" = "Drupal\field\FieldStorageConfigStorage"
  },
  config_prefix = "storage",
  entity_keys = {
    "id" = "id",
    "label" = "id"
  },
  config_export = {
    "id",
    "field_name",
    "entity_type",
    "type",
    "settings",
    "module",
    "locked",
    "cardinality",
    "translatable",
    "indexes",
    "persist_with_no_fields",
    "custom_storage",
  }
)

Hierarchy

File

core/modules/field/src/Entity/FieldStorageConfig.php, line 44

Namespace

Drupal\field\Entity

Members

Name Modifiers Type Description
ConfigEntityBase::$isSyncing private property Whether the config is being created, updated or deleted through the import process.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity.
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides Entity::createDuplicate
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides Entity::getCacheTagsToInvalidate
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides Entity::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing public function Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval
ConfigEntityBase::save public function Saves an entity permanently. Overrides Entity::save
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setSyncing public function Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label.
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides Entity::toArray
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides Entity::urlInfo
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep
DependencySerializationTrait::__wakeup public function
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId protected property The entity type.
Entity::$typedData protected property A typed data object wrapping this entity.
Entity::access public function Checks data value access. Overrides AccessibleInterface::access
Entity::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
Entity::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
Entity::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
Entity::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated protected function Gets the entity manager.
Entity::entityTypeManager protected function Gets the entity type manager.
Entity::getCacheContexts public function The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags public function The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::label public function Gets the label of the entity. Overrides EntityInterface::label
Entity::language public function Gets the language of the entity. Overrides EntityInterface::language
Entity::languageManager protected function Gets the language manager.
Entity::linkTemplates protected function Gets an array link templates.
Entity::load public static function Loads an entity. Overrides EntityInterface::load
Entity::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
Entity::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
Entity::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
Entity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
Entity::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
Entity::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters protected function Gets an array of placeholders for this entity.
Entity::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
Entity::uuidGenerator protected function Gets the UUID generator.
FieldStorageConfig::$cardinality protected property The field cardinality.
FieldStorageConfig::$custom_storage public property A boolean indicating whether or not the field item uses custom storage.
FieldStorageConfig::$deleted protected property Flag indicating whether the field is deleted.
FieldStorageConfig::$entity_type protected property The name of the entity type the field can be attached to.
FieldStorageConfig::$field_name protected property The field name.
FieldStorageConfig::$id protected property The field ID.
FieldStorageConfig::$inDeletion protected static property Static flag set to prevent recursion during field deletes.
FieldStorageConfig::$indexes protected property The custom storage indexes for the field data storage.
FieldStorageConfig::$locked protected property Flag indicating whether the field is available for editing.
FieldStorageConfig::$module protected property The name of the module that provides the field type.
FieldStorageConfig::$persist_with_no_fields protected property Flag indicating whether the field storage should be deleted when orphaned.
FieldStorageConfig::$propertyDefinitions protected property An array of field property definitions.
FieldStorageConfig::$schema protected property The field schema.
FieldStorageConfig::$settings protected property Field-type specific settings.
FieldStorageConfig::$translatable protected property Flag indicating whether the field is translatable.
FieldStorageConfig::$type protected property The field type.
FieldStorageConfig::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
FieldStorageConfig::getBundles public function Returns the list of bundles where the field storage has fields. Overrides FieldStorageConfigInterface::getBundles
FieldStorageConfig::getCardinality public function Returns the maximum number of items allowed for the field. Overrides FieldStorageDefinitionInterface::getCardinality
FieldStorageConfig::getColumns public function Returns the field columns, as defined in the field schema. Overrides FieldStorageDefinitionInterface::getColumns
FieldStorageConfig::getConstraint public function Returns a validation constraint. Overrides FieldStorageDefinitionInterface::getConstraint
FieldStorageConfig::getConstraints public function Returns an array of validation constraints. Overrides FieldStorageDefinitionInterface::getConstraints
FieldStorageConfig::getDescription public function Returns the human-readable description for the field. Overrides FieldStorageDefinitionInterface::getDescription
FieldStorageConfig::getFieldItemClass protected function Helper to retrieve the field item class.
FieldStorageConfig::getIndexes public function Returns the custom storage indexes for the field data storage. Overrides FieldStorageConfigInterface::getIndexes
FieldStorageConfig::getLabel public function Returns the human-readable label for the field. Overrides FieldStorageDefinitionInterface::getLabel
FieldStorageConfig::getMainPropertyName public function Returns the name of the main property, if any. Overrides FieldStorageDefinitionInterface::getMainPropertyName
FieldStorageConfig::getName public function Returns the machine name of the field. Overrides FieldStorageDefinitionInterface::getName
FieldStorageConfig::getOptionsProvider public function Gets an options provider for the given field item property. Overrides FieldStorageDefinitionInterface::getOptionsProvider
FieldStorageConfig::getPropertyDefinition public function Gets the definition of a contained property. Overrides FieldStorageDefinitionInterface::getPropertyDefinition
FieldStorageConfig::getPropertyDefinitions public function Gets an array of property definitions of contained properties. Overrides FieldStorageDefinitionInterface::getPropertyDefinitions
FieldStorageConfig::getPropertyNames public function Returns the names of the field's subproperties. Overrides FieldStorageDefinitionInterface::getPropertyNames
FieldStorageConfig::getProvider public function Returns the name of the provider of this field. Overrides FieldStorageDefinitionInterface::getProvider
FieldStorageConfig::getSchema public function Returns the field schema. Overrides FieldStorageDefinitionInterface::getSchema
FieldStorageConfig::getSetting public function Returns the value of a given storage setting. Overrides FieldStorageDefinitionInterface::getSetting
FieldStorageConfig::getSettings public function Returns the storage settings. Overrides FieldStorageDefinitionInterface::getSettings
FieldStorageConfig::getTargetEntityTypeId public function Returns the ID of the entity type the field is attached to. Overrides FieldStorageDefinitionInterface::getTargetEntityTypeId
FieldStorageConfig::getType public function Returns the field type. Overrides FieldStorageConfigInterface::getType
FieldStorageConfig::getTypeProvider public function Returns the name of the module providing the field type. Overrides FieldStorageConfigInterface::getTypeProvider
FieldStorageConfig::getUniqueStorageIdentifier public function Returns a unique identifier for the field. Overrides FieldStorageDefinitionInterface::getUniqueStorageIdentifier
FieldStorageConfig::hasCustomStorage public function Returns the storage behavior for this field. Overrides FieldStorageDefinitionInterface::hasCustomStorage
FieldStorageConfig::hasData public function Determines whether a field has any data.
FieldStorageConfig::id public function Gets the identifier. Overrides Entity::id
FieldStorageConfig::isBaseField public function Determines whether the field is a base field. Overrides FieldStorageDefinitionInterface::isBaseField
FieldStorageConfig::isDeletable public function Checks if the field storage can be deleted. Overrides FieldStorageConfigInterface::isDeletable
FieldStorageConfig::isDeleted public function Returns whether the field is deleted or not. Overrides FieldStorageConfigInterface::isDeleted
FieldStorageConfig::isLocked public function Returns whether the field storage is locked or not. Overrides FieldStorageConfigInterface::isLocked
FieldStorageConfig::isMultiple public function Returns whether the field can contain multiple items. Overrides FieldStorageDefinitionInterface::isMultiple
FieldStorageConfig::isQueryable public function Determines whether the field is queryable via QueryInterface. Overrides FieldStorageDefinitionInterface::isQueryable
FieldStorageConfig::isRevisionable public function Returns whether the field is revisionable. Overrides FieldStorageDefinitionInterface::isRevisionable
FieldStorageConfig::isTranslatable public function Returns whether the field supports translation. Overrides FieldStorageDefinitionInterface::isTranslatable
FieldStorageConfig::loadByName public static function Loads a field config entity based on the entity type and field name.
FieldStorageConfig::NAME_MAX_LENGTH constant The maximum length of the field name, in characters.
FieldStorageConfig::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides Entity::postDelete
FieldStorageConfig::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides Entity::postSave
FieldStorageConfig::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
FieldStorageConfig::preSave public function Overrides \Drupal\Core\Entity\Entity::preSave(). Overrides ConfigEntityBase::preSave
FieldStorageConfig::preSaveNew protected function Prepares saving a new field definition.
FieldStorageConfig::preSaveUpdated protected function Prepares saving an updated field definition.
FieldStorageConfig::setCardinality public function Sets the maximum number of items allowed for the field. Overrides FieldStorageConfigInterface::setCardinality
FieldStorageConfig::setIndexes public function Sets the custom storage indexes for the field data storage.. Overrides FieldStorageConfigInterface::setIndexes
FieldStorageConfig::setLocked public function Sets the locked flag. Overrides FieldStorageConfigInterface::setLocked
FieldStorageConfig::setSetting public function Sets the value for a field setting by name. Overrides FieldStorageConfigInterface::setSetting
FieldStorageConfig::setSettings public function Sets field storage settings. Overrides FieldStorageConfigInterface::setSettings
FieldStorageConfig::setTranslatable public function Sets whether the field is translatable. Overrides FieldStorageConfigInterface::setTranslatable
FieldStorageConfig::__construct public function Constructs a FieldStorageConfig object. Overrides ConfigEntityBase::__construct
FieldStorageConfig::__sleep public function Implements the magic __sleep() method. Overrides ConfigEntityBase::__sleep
FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED constant Value indicating a field accepts an unlimited number of values.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance.
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyTrait::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyTrait::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge
doc_Drupal
doc_Drupal
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.