interface FieldStorageConfigInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/field/src/FieldStorageConfigInterface.php \Drupal\field\FieldStorageConfigInterface
Provides an interface defining a field storage entity.
Hierarchy
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface; interface \Drupal\Core\Field\FieldStorageDefinitionInterface
- interface \Drupal\field\FieldStorageConfigInterface
Expanded class hierarchy of FieldStorageConfigInterface
All classes that implement FieldStorageConfigInterface
24 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.
- field.module in core/
modules/ field/ field.module - Attach custom data fields to Drupal entities.
- field.purge.inc in core/
modules/ field/ field.purge.inc - Provides support for field data purge after mass deletion.
- FieldConfig.php in core/
modules/ field/ src/ Entity/ FieldConfig.php - Contains \Drupal\field\Entity\FieldConfig.
File
- core/
modules/ field/ src/ FieldStorageConfigInterface.php, line 16 - Contains \Drupal\field\FieldStorageConfigInterface.
Namespace
Drupal\fieldView source
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();
/**
* Returns whether the field is deleted or not.
*
* @return bool
* TRUE if the field is deleted.
*/
public function isDeleted();
/**
* 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:: |
public | function | Checks data value access. | 5 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 26 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 26 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 19 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed as part of an import process. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 3 |
ConfigEntityInterface:: |
public | function | Sets the status of the isSyncing flag. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on an entity after it is created but before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the public URL for this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
FieldStorageConfigInterface:: |
public | function | Returns the list of bundles where the field storage has fields. | 1 |
FieldStorageConfigInterface:: |
public | function | Returns the custom storage indexes for the field data storage. | 1 |
FieldStorageConfigInterface:: |
public | function |
Returns the field type. Overrides FieldStorageDefinitionInterface:: |
1 |
FieldStorageConfigInterface:: |
public | function | Returns the name of the module providing the field type. | 1 |
FieldStorageConfigInterface:: |
public | function | Checks if the field storage can be deleted. | 1 |
FieldStorageConfigInterface:: |
public | function | Returns whether the field is deleted or not. | 1 |
FieldStorageConfigInterface:: |
public | function | Returns whether the field storage is locked or not. | 1 |
FieldStorageConfigInterface:: |
public | function | Sets the maximum number of items allowed for the field. | 1 |
FieldStorageConfigInterface:: |
public | function | Sets the custom storage indexes for the field data storage.. | 1 |
FieldStorageConfigInterface:: |
public | function | Sets the locked flag. | 1 |
FieldStorageConfigInterface:: |
public | function | Sets the value for a field setting by name. | 1 |
FieldStorageConfigInterface:: |
public | function | Sets field storage settings. | 1 |
FieldStorageConfigInterface:: |
public | function |
Sets whether the field is translatable. Overrides FieldStorageDefinitionInterface:: |
1 |
FieldStorageDefinitionInterface:: |
constant | Value indicating a field accepts an unlimited number of values. | ||
FieldStorageDefinitionInterface:: |
public | function | Returns the maximum number of items allowed for the field. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the field columns, as defined in the field schema. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns a validation constraint. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns an array of validation constraints. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns the human-readable description for the field. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns the human-readable label for the field. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns the name of the main property, if any. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the machine name of the field. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Gets an options provider for the given field item property. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Gets the definition of a contained property. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Gets an array of property definitions of contained properties. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the names of the field's subproperties. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the name of the provider of this field. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the field schema. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the value of a given storage setting. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns the storage settings. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns the ID of the entity type the field is attached to. | 1 |
FieldStorageDefinitionInterface:: |
public | function | Returns a unique identifier for the field. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns the storage behavior for this field. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Determines whether the field is a base field. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns whether the field can contain multiple items. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Determines whether the field is queryable via QueryInterface. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns whether the field is revisionable. | 2 |
FieldStorageDefinitionInterface:: |
public | function | Returns whether the field supports translation. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 3 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 3 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 3 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 3 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 3 |