interface FieldConfigInterface in Drupal 8

Provides an interface defining a field entity.

Hierarchy

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

15 files declare their use of FieldConfigInterface

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

Enables users to comment on published content.

config_translation.module in core/modules/config_translation/config_translation.module

Configuration Translation module.

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

Attach custom data fields to Drupal entities.

FieldConfig.php in core/modules/field/src/Entity/FieldConfig.php

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

... See full list

File

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

Namespace

Drupal\field

interface FieldConfigInterface extends ConfigEntityInterface, FieldDefinitionInterface {

  /**
   * Gets the deleted flag of the field.
   *
   * @return bool
   *   Returns TRUE if the field is deleted.
   */
  public function isDeleted();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
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
DataDefinitionInterface::addConstraint	public	function	Adds a validation constraint.	2
DataDefinitionInterface::createFromDataType	public static	function	Creates a new data definition object.	2
DataDefinitionInterface::getClass	public	function	Returns the class used for creating the typed data object.	2
DataDefinitionInterface::getConstraint	public	function	Returns a validation constraint.	2
DataDefinitionInterface::getConstraints	public	function	Returns an array of validation constraints.	2
DataDefinitionInterface::getDataType	public	function	Returns the data type of the data.	2
DataDefinitionInterface::getDescription	public	function	Returns a human readable description.	2
DataDefinitionInterface::getLabel	public	function	Returns a human readable label.	2
DataDefinitionInterface::getSetting	public	function	Returns the value of a given setting.	2
DataDefinitionInterface::getSettings	public	function	Returns the array of settings, as required by the used class.	2
DataDefinitionInterface::isComputed	public	function	Determines whether the data value is computed.	3
DataDefinitionInterface::isInternal	public	function	Determines whether the data value is internal.	2
DataDefinitionInterface::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items.	2
DataDefinitionInterface::isReadOnly	public	function	Determines whether the data is read-only.	3
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
FieldConfigInterface::isDeleted	public	function	Gets the deleted flag of the field.	1
FieldDefinitionInterface::getConfig	public	function	Gets an object that can be saved in configuration.	3
FieldDefinitionInterface::getDefaultValue	public	function	Returns the default value for the field in a newly created entity.	3
FieldDefinitionInterface::getDefaultValueCallback	public	function	Returns the default value callback for the field.	3
FieldDefinitionInterface::getDefaultValueLiteral	public	function	Returns the default value literal for the field.	3
FieldDefinitionInterface::getDisplayOptions	public	function	Returns the default display options for the field.	4
FieldDefinitionInterface::getFieldStorageDefinition	public	function	Returns the field storage definition.	4
FieldDefinitionInterface::getName	public	function	Returns the machine name of the field.	3
FieldDefinitionInterface::getTargetBundle	public	function	Gets the bundle the field is attached to.	3
FieldDefinitionInterface::getTargetEntityTypeId	public	function	Returns the ID of the entity type the field is attached to.	3
FieldDefinitionInterface::getType	public	function	Returns the field type.	3
FieldDefinitionInterface::getUniqueIdentifier	public	function	Returns a unique identifier for the field.	4
FieldDefinitionInterface::isDisplayConfigurable	public	function	Returns whether the display for the field can be configured.	4
FieldDefinitionInterface::isRequired	public	function	Returns whether the field can be empty. Overrides DataDefinitionInterface::isRequired	1
FieldDefinitionInterface::isTranslatable	public	function	Returns whether the field is translatable.	3
ListDataDefinitionInterface::createFromItemType	public static	function	Creates a new list data definition for items of the given data type.	2
ListDataDefinitionInterface::getItemDefinition	public	function	Gets the data definition of an item of the list.	2
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.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5