interface FieldStorageConfigInterface in Drupal 10

Provides an interface defining a field storage entity.

Hierarchy

• interface \Drupal\Core\Config\Entity\ConfigEntityInterface; interface \Drupal\Core\Field\FieldStorageDefinitionInterface
  • interface \Drupal\field\FieldStorageConfigInterface

18 files declare their use of FieldStorageConfigInterface

comment.module in core/modules/comment/comment.module

Enables users to comment on published content.

datetime.views.inc in core/modules/datetime/datetime.views.inc

Provides views data for the datetime module.

datetime_range.views.inc in core/modules/datetime_range/datetime_range.views.inc

Provides views data for the datetime_range module.

field.module in core/modules/field/field.module

Attach custom data fields to Drupal entities.

FieldStorageAddForm.php in core/modules/field_ui/src/Form/FieldStorageAddForm.php

... See full list

File

core/modules/field/src/FieldStorageConfigInterface.php, line 11

Namespace

Drupal\field

interface FieldStorageConfigInterface extends ConfigEntityInterface, FieldStorageDefinitionInterface {

  /**
   * Returns the field type.
   *
   * @return string
   *   The field type, i.e. the id of a field type plugin. For example 'text'.
   */
  public function getType();

  /**
   * Returns the name of the module providing the field type.
   *
   * @return string
   *   The name of the module that provides the field type.
   */
  public function getTypeProvider();

  /**
   * Returns the list of bundles where the field storage has fields.
   *
   * @return array
   *   An array of bundle names.
   */
  public function getBundles();

  /**
   * Checks if the field storage can be deleted.
   *
   * @return bool
   *   TRUE if the field storage can be deleted.
   */
  public function isDeletable();

  /**
   * Returns whether the field storage is locked or not.
   *
   * @return bool
   *   TRUE if the field storage is locked.
   */
  public function isLocked();

  /**
   * Sets the locked flag.
   *
   * @param bool $locked
   *   Sets value of locked flag.
   *
   * @return $this
   */
  public function setLocked($locked);

  /**
   * Sets the maximum number of items allowed for the field.
   *
   * @param int $cardinality
   *   The cardinality value.
   *
   * @return $this
   */
  public function setCardinality($cardinality);

  /**
   * Sets the value for a field setting by name.
   *
   * @param string $setting_name
   *   The name of the setting.
   * @param mixed $value
   *   The value of the setting.
   *
   * @return $this
   */
  public function setSetting($setting_name, $value);

  /**
   * Sets field storage settings.
   *
   * Note that the method does not unset existing settings not specified in the
   * incoming $settings array.
   *
   * For example:
   * @code
   *   // Given these are the default settings.
   *   $storage_definition->getSettings() === [
   *     'fruit' => 'apple',
   *     'season' => 'summer',
   *   ];
   *   // Change only the 'fruit' setting.
   *   $storage_definition->setSettings(['fruit' => 'banana']);
   *   // The 'season' setting persists unchanged.
   *   $storage_definition->getSettings() === [
   *     'fruit' => 'banana',
   *     'season' => 'summer',
   *   ];
   * @endcode
   *
   * For clarity, it is preferred to use setSetting() if not all available
   * settings are supplied.
   *
   * @param array $settings
   *   The array of storage settings.
   *
   * @return $this
   */
  public function setSettings(array $settings);

  /**
   * Sets whether the field is translatable.
   *
   * @param bool $translatable
   *   Whether the field is translatable.
   *
   * @return $this
   */
  public function setTranslatable($translatable);

  /**
   * Returns the custom storage indexes for the field data storage.
   *
   * @return array
   *   An array of custom indexes.
   */
  public function getIndexes();

  /**
   * Sets the custom storage indexes for the field data storage..
   *
   * @param array $indexes
   *   The array of custom indexes.
   *
   * @return $this
   */
  public function setIndexes(array $indexes);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	4
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	24
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	24
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	17
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	1
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	1
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	1
EntityInterface::delete	public	function	Deletes an entity permanently.	1
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	1
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	1
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	1
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	1
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	1
EntityInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	1
EntityInterface::getOriginalId	public	function	Gets the original ID.	1
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	1
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	1
EntityInterface::id	public	function	Gets the identifier.	1
EntityInterface::isNew	public	function	Determines whether the entity is new.	1
EntityInterface::label	public	function	Gets the label of the entity.	1
EntityInterface::language	public	function	Gets the language of the entity.	1
EntityInterface::load	public static	function	Loads an entity.	1
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	1
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	1
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	1
EntityInterface::postLoad	public static	function	Acts on loaded entities.	1
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	1
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	1
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	1
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	1
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	1
EntityInterface::save	public	function	Saves an entity permanently.	1
EntityInterface::setOriginalId	public	function	Sets the original ID.	1
EntityInterface::toArray	public	function	Gets an array of all property values.	1
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	1
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	1
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	1
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	1
FieldStorageConfigInterface::getBundles	public	function	Returns the list of bundles where the field storage has fields.
FieldStorageConfigInterface::getIndexes	public	function	Returns the custom storage indexes for the field data storage.
FieldStorageConfigInterface::getType	public	function	Returns the field type. Overrides FieldStorageDefinitionInterface::getType
FieldStorageConfigInterface::getTypeProvider	public	function	Returns the name of the module providing the field type.
FieldStorageConfigInterface::isDeletable	public	function	Checks if the field storage can be deleted.
FieldStorageConfigInterface::isLocked	public	function	Returns whether the field storage is locked or not.
FieldStorageConfigInterface::setCardinality	public	function	Sets the maximum number of items allowed for the field.
FieldStorageConfigInterface::setIndexes	public	function	Sets the custom storage indexes for the field data storage..
FieldStorageConfigInterface::setLocked	public	function	Sets the locked flag.
FieldStorageConfigInterface::setSetting	public	function	Sets the value for a field setting by name.
FieldStorageConfigInterface::setSettings	public	function	Sets field storage settings.
FieldStorageConfigInterface::setTranslatable	public	function	Sets whether the field is translatable. Overrides FieldStorageDefinitionInterface::setTranslatable
FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED		constant	Value indicating a field accepts an unlimited number of values.
FieldStorageDefinitionInterface::getCardinality	public	function	Returns the maximum number of items allowed for the field.	1
FieldStorageDefinitionInterface::getColumns	public	function	Returns the field columns, as defined in the field schema.	1
FieldStorageDefinitionInterface::getConstraint	public	function	Returns a validation constraint.
FieldStorageDefinitionInterface::getConstraints	public	function	Returns an array of validation constraints.
FieldStorageDefinitionInterface::getDescription	public	function	Returns the human-readable description for the field.
FieldStorageDefinitionInterface::getLabel	public	function	Returns the human-readable label for the field.
FieldStorageDefinitionInterface::getMainPropertyName	public	function	Returns the name of the main property, if any.	1
FieldStorageDefinitionInterface::getName	public	function	Returns the machine name of the field.
FieldStorageDefinitionInterface::getOptionsProvider	public	function	Gets an options provider for the given field item property.	1
FieldStorageDefinitionInterface::getPropertyDefinition	public	function	Gets the definition of a contained property.	1
FieldStorageDefinitionInterface::getPropertyDefinitions	public	function	Gets an array of property definitions of contained properties.	1
FieldStorageDefinitionInterface::getPropertyNames	public	function	Returns the names of the field's subproperties.	1
FieldStorageDefinitionInterface::getProvider	public	function	Returns the name of the provider of this field.	1
FieldStorageDefinitionInterface::getSchema	public	function	Returns the field schema.	1
FieldStorageDefinitionInterface::getSetting	public	function	Returns the value of a given storage setting.
FieldStorageDefinitionInterface::getSettings	public	function	Returns the storage settings.
FieldStorageDefinitionInterface::getTargetEntityTypeId	public	function	Returns the ID of the entity type the field is attached to.
FieldStorageDefinitionInterface::getUniqueStorageIdentifier	public	function	Returns a unique identifier for the field storage.	1
FieldStorageDefinitionInterface::hasCustomStorage	public	function	Returns the storage behavior for this field.	1
FieldStorageDefinitionInterface::isBaseField	public	function	Determines whether the field is a base field.	1
FieldStorageDefinitionInterface::isDeleted	public	function	Returns whether the field is deleted or not.	1
FieldStorageDefinitionInterface::isMultiple	public	function	Returns whether the field can contain multiple items.	1
FieldStorageDefinitionInterface::isRevisionable	public	function	Returns whether the field storage is revisionable.	1
FieldStorageDefinitionInterface::isTranslatable	public	function	Returns whether the field supports translation.
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	4
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	4
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	4
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	4
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	4