interface FieldConfigInterface

Defines an interface for configurable field definitions.

This interface allows both configurable fields and overridden base fields to share a common interface. The interface also extends ConfigEntityInterface to ensure that implementations have the expected save() method.

Hierarchy

• interface \Drupal\Core\Field\FieldDefinitionInterface; interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  • interface \Drupal\Core\Field\FieldConfigInterface

See also

\Drupal\Core\Field\Entity\BaseFieldOverride

\Drupal\field\Entity\FieldConfig

File

core/lib/Drupal/Core/Field/FieldConfigInterface.php, line 17

Namespace

Drupal\Core\Field

Members

Name	Modifiers	Type	Description
AccessibleInterface::access	public	function	Checks data value access. Overrides AccessibleInterface::access
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.
ConfigEntityInterface::disable	public	function	Disables the configuration entity.
ConfigEntityInterface::enable	public	function	Enables the configuration entity.
ConfigEntityInterface::get	public	function	Returns the value of a property.
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.
ConfigEntityInterface::isSyncing	public	function	Returns whether this entity is being changed as part of an import process.
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.
ConfigEntityInterface::set	public	function	Sets the value of a property.
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.
ConfigEntityInterface::setSyncing	public	function	Sets the status of the isSyncing flag.
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.
DataDefinitionInterface::createFromDataType	public static	function	Creates a new data definition object.
DataDefinitionInterface::getClass	public	function	Returns the class used for creating the typed data object.
DataDefinitionInterface::getConstraint	public	function	Returns a validation constraint.
DataDefinitionInterface::getConstraints	public	function	Returns an array of validation constraints.
DataDefinitionInterface::getDataType	public	function	Returns the data type of the data.
DataDefinitionInterface::getDescription	public	function	Returns a human readable description.
DataDefinitionInterface::getLabel	public	function	Returns a human readable label.
DataDefinitionInterface::getSetting	public	function	Returns the value of a given setting.
DataDefinitionInterface::getSettings	public	function	Returns the array of settings, as required by the used class.
DataDefinitionInterface::isComputed	public	function	Determines whether the data value is computed.
DataDefinitionInterface::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items.
DataDefinitionInterface::isReadOnly	public	function	Determines whether the data is read-only.
EntityInterface::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityInterface::createDuplicate
EntityInterface::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget
EntityInterface::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityInterface::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityInterface::id	public	function	Gets the identifier. Overrides EntityInterface::id
EntityInterface::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew
EntityInterface::label	public	function	Gets the label of the entity. Overrides EntityInterface::label
EntityInterface::language	public	function	Gets the language of the entity. Overrides EntityInterface::language
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link
EntityInterface::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityInterface::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete
EntityInterface::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
EntityInterface::save	public	function	Saves an entity permanently. Overrides EntityInterface::save
EntityInterface::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId
EntityInterface::toArray	public	function	Gets an array of all property values. Overrides EntityInterface::toArray
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityInterface::toUrl	public	function	Gets the URL object for the entity. Overrides EntityInterface::toUrl
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity. Overrides EntityInterface::url
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
FieldConfigInterface::addConstraint	public	function	Adds a validation constraint to the FieldItemList. Overrides DataDefinitionInterface::addConstraint
FieldConfigInterface::addPropertyConstraints	public	function	Adds constraints for a given field item property.
FieldConfigInterface::setConstraints	public	function	Sets the array of validation constraints for the FieldItemList.
FieldConfigInterface::setDefaultValue	public	function	Sets a default value.
FieldConfigInterface::setDefaultValueCallback	public	function	Sets a custom default value callback.
FieldConfigInterface::setDescription	public	function	Sets a human readable description.
FieldConfigInterface::setLabel	public	function	Sets the field definition label.
FieldConfigInterface::setPropertyConstraints	public	function	Sets constraints for a given field item property.
FieldConfigInterface::setRequired	public	function	Sets whether the field can be empty.
FieldConfigInterface::setSetting	public	function	Sets the value for a field setting by name.
FieldConfigInterface::setSettings	public	function	Sets field settings.
FieldConfigInterface::setTranslatable	public	function	Sets whether the field is translatable.
FieldDefinitionInterface::getConfig	public	function	Gets an object that can be saved in configuration.
FieldDefinitionInterface::getDefaultValue	public	function	Returns the default value for the field in a newly created entity.
FieldDefinitionInterface::getDefaultValueCallback	public	function	Returns the default value callback for the field.
FieldDefinitionInterface::getDefaultValueLiteral	public	function	Returns the default value literal for the field.
FieldDefinitionInterface::getDisplayOptions	public	function	Returns the default display options for the field.
FieldDefinitionInterface::getFieldStorageDefinition	public	function	Returns the field storage definition.
FieldDefinitionInterface::getName	public	function	Returns the machine name of the field.
FieldDefinitionInterface::getTargetBundle	public	function	Gets the bundle the field is attached to.
FieldDefinitionInterface::getTargetEntityTypeId	public	function	Returns the ID of the entity type the field is attached to.
FieldDefinitionInterface::getType	public	function	Returns the field type.
FieldDefinitionInterface::isDisplayConfigurable	public	function	Returns whether the display for the field can be configured.
FieldDefinitionInterface::isRequired	public	function	Returns whether the field can be empty. Overrides DataDefinitionInterface::isRequired
FieldDefinitionInterface::isTranslatable	public	function	Returns whether the field is translatable.
ListDataDefinitionInterface::createFromItemType	public static	function	Creates a new list data definition for items of the given data type.
ListDataDefinitionInterface::getItemDefinition	public	function	Gets the data definition of an item of the list.
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.