class FieldConfig

Same name and namespace in other branches
  1. 8.9.x core/modules/field/src/Entity/FieldConfig.php \Drupal\field\Entity\FieldConfig
  2. 10 core/modules/field/src/Entity/FieldConfig.php \Drupal\field\Entity\FieldConfig
  3. 11.x core/modules/field/src/Entity/FieldConfig.php \Drupal\field\Entity\FieldConfig

Defines the Field entity.

Plugin annotation

  id = "field_config",
  label = @Translation("Field"),
  label_collection = @Translation("Fields"),
  label_singular = @Translation("field"),
  label_plural = @Translation("fields"),
  label_count = @PluralTranslation(
    singular = "@count field",
    plural = "@count fields",
  handlers = {
    "access" = "Drupal\field\FieldConfigAccessControlHandler",
    "storage" = "Drupal\field\FieldConfigStorage"
  config_prefix = "field",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  config_export = {


Expanded class hierarchy of FieldConfig

303 files declare their use of FieldConfig
ArbitraryRebuildTest.php in core/modules/system/tests/src/Functional/Form/ArbitraryRebuildTest.php
block_content.module in core/modules/block_content/block_content.module
Allows the creation of custom blocks through the user interface.
BooleanFieldTest.php in core/modules/field/tests/src/Functional/Boolean/BooleanFieldTest.php
BooleanFormatterSettingsTest.php in core/modules/field/tests/src/FunctionalJavascript/Boolean/BooleanFormatterSettingsTest.php
BooleanFormatterSettingsTest.php in core/modules/field/tests/src/Functional/Boolean/BooleanFormatterSettingsTest.php

... See full list


core/modules/field/src/Entity/FieldConfig.php, line 50


View source
class FieldConfig extends FieldConfigBase implements FieldConfigInterface {
     * Flag indicating whether the field is deleted.
     * The delete() method marks the field as "deleted" and removes the
     * corresponding entry from the config storage, but keeps its definition in
     * the state storage while field data is purged by a separate
     * garbage-collection process.
     * Deleted fields stay out of the regular entity lifecycle (notably, their
     * values are not populated in loaded entities, and are not saved back).
     * @var bool
    protected $deleted = FALSE;
     * The associated FieldStorageConfig entity.
     * @var \Drupal\field\Entity\FieldStorageConfig
    protected $fieldStorage;
     * Constructs a FieldConfig object.
     * In most cases, Field entities are created via
     * FieldConfig::create($values), where $values is the same
     * parameter as in this constructor.
     * @param array $values
     *   An array of field properties, keyed by property name. The
     *   storage associated with the field can be specified either with:
     *   - field_storage: the FieldStorageConfigInterface object,
     *   or by referring to an existing field storage in the current configuration
     *   with:
     *   - field_name: The field name.
     *   - entity_type: The entity type.
     *   Additionally, a 'bundle' property is required to indicate the entity
     *   bundle to which the field is attached to. Other array elements will be
     *   used to set the corresponding properties on the class; see the class
     *   property documentation for details.
     * @param string $entity_type
     *   (optional) The entity type on which the field should be created.
     *   Defaults to "field_config".
    public function __construct(array $values, $entity_type = 'field_config') {
        // Allow either an injected FieldStorageConfig object, or a field_name and
        // entity_type.
        if (isset($values['field_storage'])) {
            if (!$values['field_storage'] instanceof FieldStorageConfigInterface) {
                throw new FieldException('Attempt to create a configurable field for a non-configurable field storage.');
            $field_storage = $values['field_storage'];
            $values['field_name'] = $field_storage->getName();
            $values['entity_type'] = $field_storage->getTargetEntityTypeId();
            // The internal property is fieldStorage, not field_storage.
            $values['fieldStorage'] = $field_storage;
        else {
            if (empty($values['field_name'])) {
                throw new FieldException('Attempt to create a field without a field_name.');
            if (empty($values['entity_type'])) {
                throw new FieldException("Attempt to create a field '{$values['field_name']}' without an entity_type.");
        // 'bundle' is required in either case.
        if (empty($values['bundle'])) {
            throw new FieldException("Attempt to create a field '{$values['field_name']}' without a bundle.");
        parent::__construct($values, $entity_type);
     * {@inheritdoc}
    public function postCreate(EntityStorageInterface $storage) {
        // Validate that we have a valid storage for this field. This throws an
        // exception if the storage is invalid.
        // 'Label' defaults to the field name (mostly useful for fields created in
        // tests).
        if (empty($this->label)) {
            $this->label = $this->getName();
     * Overrides \Drupal\Core\Entity\Entity::preSave().
     * @throws \Drupal\Core\Field\FieldException
     *   If the field definition is invalid.
     * @throws \Drupal\Core\Entity\EntityStorageException
     *   In case of failures at the configuration storage level.
    public function preSave(EntityStorageInterface $storage) {
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        $storage_definition = $this->getFieldStorageDefinition();
        // Filter out unknown settings and make sure all settings are present, so
        // that a complete field definition is passed to the various hooks and
        // written to config.
        $default_settings = $field_type_manager->getDefaultFieldSettings($storage_definition->getType());
        $this->settings = array_intersect_key($this->settings, $default_settings) + $default_settings;
        if ($this->isNew()) {
            // Notify the entity storage.
        else {
            // Some updates are always disallowed.
            if ($this->entity_type != $this->original->entity_type) {
                throw new FieldException("Cannot change an existing field's entity_type.");
            if ($this->bundle != $this->original->bundle) {
                throw new FieldException("Cannot change an existing field's bundle.");
            if ($storage_definition->uuid() != $this->original
                ->uuid()) {
                throw new FieldException("Cannot change an existing field's storage.");
            // Notify the entity storage.
            \Drupal::service('field_definition.listener')->onFieldDefinitionUpdate($this, $this->original);
     * {@inheritdoc}
    public function calculateDependencies() {
        // Mark the field_storage_config as a dependency.
        $this->addDependency('config', $this->getFieldStorageDefinition()
        return $this;
     * {@inheritdoc}
    public static function preDelete(EntityStorageInterface $storage, array $fields) {
        /** @var \Drupal\Core\Field\DeletedFieldsRepositoryInterface $deleted_fields_repository */
        $deleted_fields_repository = \Drupal::service('entity_field.deleted_fields_repository');
        $entity_type_manager = \Drupal::entityTypeManager();
        parent::preDelete($storage, $fields);
        // Keep the field definitions in the deleted fields repository so we can use
        // them later during field_purge_batch().
        /** @var \Drupal\field\FieldConfigInterface $field */
        foreach ($fields as $field) {
            // Only mark a field for purging if there is data. Otherwise, just remove
            // it.
            $target_entity_storage = $entity_type_manager->getStorage($field->getTargetEntityTypeId());
            if (!$field->deleted && $target_entity_storage instanceof FieldableEntityStorageInterface && $target_entity_storage->countFieldData($field->getFieldStorageDefinition(), TRUE)) {
                $field = clone $field;
                $field->deleted = TRUE;
                $field->fieldStorage = NULL;
     * {@inheritdoc}
    public static function postDelete(EntityStorageInterface $storage, array $fields) {
        // Clear the cache upfront, to refresh the results of getBundles().
        // Notify the entity storage.
        foreach ($fields as $field) {
            if (!$field->deleted) {
        // If this is part of a configuration synchronization then the following
        // configuration updates are not necessary.
        $entity = reset($fields);
        if ($entity->isSyncing()) {
        // Delete the associated field storages if they are not used anymore and are
        // not persistent.
        $storages_to_delete = [];
        foreach ($fields as $field) {
            $storage_definition = $field->getFieldStorageDefinition();
            if (!$field->deleted && !$field->isUninstalling() && $storage_definition->isDeletable()) {
                // Key by field UUID to avoid deleting the same storage twice.
                $storages_to_delete[$storage_definition->uuid()] = $storage_definition;
        if ($storages_to_delete) {
     * {@inheritdoc}
    protected function linkTemplates() {
        $link_templates = parent::linkTemplates();
        if (\Drupal::moduleHandler()->moduleExists('field_ui')) {
            $link_templates["{$this->entity_type}-field-edit-form"] = 'entity.field_config.' . $this->entity_type . '_field_edit_form';
            $link_templates["{$this->entity_type}-storage-edit-form"] = 'entity.field_config.' . $this->entity_type . '_storage_edit_form';
            $link_templates["{$this->entity_type}-field-delete-form"] = 'entity.field_config.' . $this->entity_type . '_field_delete_form';
            if (isset($link_templates['config-translation-overview'])) {
                $link_templates["config-translation-overview.{$this->entity_type}"] = "entity.field_config.config_translation_overview.{$this->entity_type}";
        return $link_templates;
     * {@inheritdoc}
    protected function urlRouteParameters($rel) {
        $parameters = parent::urlRouteParameters($rel);
        $entity_type = \Drupal::entityTypeManager()->getDefinition($this->entity_type);
        $bundle_parameter_key = $entity_type->getBundleEntityType() ?: 'bundle';
        $parameters[$bundle_parameter_key] = $this->bundle;
        return $parameters;
     * {@inheritdoc}
    public function isDeleted() {
        return $this->deleted;
     * {@inheritdoc}
    public function getFieldStorageDefinition() {
        if (!$this->fieldStorage) {
            $field_storage_definition = NULL;
            $field_storage_definitions = \Drupal::service('entity_field.manager')->getFieldStorageDefinitions($this->entity_type);
            if (isset($field_storage_definitions[$this->field_name])) {
                $field_storage_definition = $field_storage_definitions[$this->field_name];
            elseif ($this->deleted) {
                $deleted_storage_definitions = \Drupal::service('entity_field.deleted_fields_repository')->getFieldStorageDefinitions();
                foreach ($deleted_storage_definitions as $deleted_storage_definition) {
                    if ($deleted_storage_definition->getName() === $this->field_name) {
                        $field_storage_definition = $deleted_storage_definition;
            if (!$field_storage_definition) {
                throw new FieldException("Attempted to create an instance of field with name {$this->field_name} on entity type {$this->entity_type} when the field storage does not exist.");
            if (!$field_storage_definition instanceof FieldStorageConfigInterface) {
                throw new FieldException("Attempted to create a configurable field of non-configurable field storage {$this->field_name}.");
            $this->fieldStorage = $field_storage_definition;
        return $this->fieldStorage;
     * {@inheritdoc}
    public function isDisplayConfigurable($context) {
        return TRUE;
     * {@inheritdoc}
    public function getDisplayOptions($display_context) {
        // Hide configurable fields by default.
        return [
            'region' => 'hidden',
     * {@inheritdoc}
    public function isReadOnly() {
        return FALSE;
     * {@inheritdoc}
    public function isComputed() {
        return FALSE;
     * {@inheritdoc}
    public function getUniqueIdentifier() {
        return $this->uuid();
     * Loads a field config entity based on the entity type and field name.
     * @param string $entity_type_id
     *   ID of the entity type.
     * @param string $bundle
     *   Bundle name.
     * @param string $field_name
     *   Name of the field.
     * @return Drupal\field\FieldConfigInterface|null
     *   The field config entity if one exists for the provided field
     *   name, otherwise NULL.
    public static function loadByName($entity_type_id, $bundle, $field_name) {
        return \Drupal::entityTypeManager()->getStorage('field_config')
            ->load($entity_type_id . '.' . $bundle . '.' . $field_name);



Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
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. 4
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
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
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 EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::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 EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
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. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::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
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
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
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 1
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
FieldConfig::$deleted protected property Flag indicating whether the field is deleted.
FieldConfig::$fieldStorage protected property The associated FieldStorageConfig entity. Overrides FieldConfigBase::$fieldStorage
FieldConfig::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides FieldConfigBase::calculateDependencies
FieldConfig::getDisplayOptions public function Returns the default display options for the field. Overrides FieldDefinitionInterface::getDisplayOptions
FieldConfig::getFieldStorageDefinition public function Returns the field storage definition. Overrides FieldDefinitionInterface::getFieldStorageDefinition
FieldConfig::getUniqueIdentifier public function Returns a unique identifier for the field. Overrides FieldDefinitionInterface::getUniqueIdentifier
FieldConfig::isComputed public function Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
FieldConfig::isDeleted public function Gets the deleted flag of the field. Overrides FieldConfigInterface::isDeleted
FieldConfig::isDisplayConfigurable public function Returns whether the display for the field can be configured. Overrides FieldDefinitionInterface::isDisplayConfigurable
FieldConfig::isReadOnly public function Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
FieldConfig::linkTemplates protected function Gets an array link templates. Overrides EntityBase::linkTemplates
FieldConfig::loadByName public static function Loads a field config entity based on the entity type and field name.
FieldConfig::postCreate public function Acts on a created entity before hooks are invoked. Overrides FieldConfigBase::postCreate
FieldConfig::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
FieldConfig::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
FieldConfig::preSave public function Overrides \Drupal\Core\Entity\Entity::preSave(). Overrides ConfigEntityBase::preSave
FieldConfig::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
FieldConfig::__construct public function Constructs a FieldConfig object. Overrides ConfigEntityBase::__construct
FieldConfigBase::$bundle protected property The name of the bundle the field is attached to.
FieldConfigBase::$constraints protected property Array of constraint options keyed by constraint plugin ID.
FieldConfigBase::$default_value protected property Default field value.
FieldConfigBase::$default_value_callback protected property The name of a callback function that returns default values.
FieldConfigBase::$description protected property The field description.
FieldConfigBase::$entity_type protected property The name of the entity type the field is attached to.
FieldConfigBase::$field_name protected property The field name.
FieldConfigBase::$field_type protected property The field type.
FieldConfigBase::$id protected property The field ID.
FieldConfigBase::$itemDefinition protected property The data definition of a field item.
FieldConfigBase::$label protected property The human-readable label for the field.
FieldConfigBase::$propertyConstraints protected property Array of property constraint options keyed by property ID.
FieldConfigBase::$required protected property Flag indicating whether the field is required.
FieldConfigBase::$settings protected property Field-type specific settings.
FieldConfigBase::$translatable protected property Flag indicating whether the field is translatable.
FieldConfigBase::addConstraint public function Adds a validation constraint to the FieldItemList. Overrides FieldConfigInterface::addConstraint
FieldConfigBase::addPropertyConstraints public function Adds constraints for a given field item property. Overrides FieldConfigInterface::addPropertyConstraints
FieldConfigBase::createFromDataType public static function Creates a new data definition object. Overrides DataDefinitionInterface::createFromDataType
FieldConfigBase::createFromItemType public static function Creates a new list data definition for items of the given data type. Overrides ListDataDefinitionInterface::createFromItemType
FieldConfigBase::getClass public function Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass 1
FieldConfigBase::getConfig public function Gets an object that can be saved in configuration. Overrides FieldDefinitionInterface::getConfig
FieldConfigBase::getConstraint public function Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
FieldConfigBase::getConstraints public function Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints
FieldConfigBase::getDataType public function Returns the data type of the data. Overrides DataDefinitionInterface::getDataType
FieldConfigBase::getDefaultValue public function Returns the default value for the field in a newly created entity. Overrides FieldDefinitionInterface::getDefaultValue
FieldConfigBase::getDefaultValueCallback public function Returns the default value callback for the field. Overrides FieldDefinitionInterface::getDefaultValueCallback
FieldConfigBase::getDefaultValueLiteral public function Returns the default value literal for the field. Overrides FieldDefinitionInterface::getDefaultValueLiteral
FieldConfigBase::getDescription public function Returns a human readable description. Overrides DataDefinitionInterface::getDescription
FieldConfigBase::getItemDefinition public function Gets the data definition of an item of the list. Overrides ListDataDefinitionInterface::getItemDefinition
FieldConfigBase::getLabel public function Returns a human readable label. Overrides DataDefinitionInterface::getLabel
FieldConfigBase::getName public function Returns the machine name of the field. Overrides FieldDefinitionInterface::getName
FieldConfigBase::getSetting public function Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting
FieldConfigBase::getSettings public function Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings
FieldConfigBase::getTargetBundle public function Gets the bundle the field is attached to. Overrides FieldDefinitionInterface::getTargetBundle
FieldConfigBase::getTargetEntityTypeId public function Returns the ID of the entity type the field is attached to. Overrides FieldDefinitionInterface::getTargetEntityTypeId
FieldConfigBase::getType public function Returns the field type. Overrides FieldDefinitionInterface::getType
FieldConfigBase::id public function Gets the identifier. Overrides EntityBase::id
FieldConfigBase::isInternal public function Determines whether the data value is internal. Overrides DataDefinitionInterface::isInternal
FieldConfigBase::isList public function Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
FieldConfigBase::isRequired public function Returns whether the field can be empty. Overrides FieldDefinitionInterface::isRequired
FieldConfigBase::isTranslatable public function Returns whether the field is translatable. Overrides FieldDefinitionInterface::isTranslatable
FieldConfigBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase::onDependencyRemoval
FieldConfigBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
FieldConfigBase::setConstraints public function Sets the array of validation constraints for the FieldItemList. Overrides FieldConfigInterface::setConstraints
FieldConfigBase::setDefaultValue public function Sets a default value. Overrides FieldConfigInterface::setDefaultValue
FieldConfigBase::setDefaultValueCallback public function Sets a custom default value callback. Overrides FieldConfigInterface::setDefaultValueCallback
FieldConfigBase::setDescription public function Sets a human readable description. Overrides FieldConfigInterface::setDescription
FieldConfigBase::setLabel public function Sets the field definition label. Overrides FieldConfigInterface::setLabel
FieldConfigBase::setPropertyConstraints public function Sets constraints for a given field item property. Overrides FieldConfigInterface::setPropertyConstraints
FieldConfigBase::setRequired public function Sets whether the field can be empty. Overrides FieldConfigInterface::setRequired
FieldConfigBase::setSetting public function Sets the value for a field setting by name. Overrides FieldConfigInterface::setSetting
FieldConfigBase::setSettings public function Sets field settings. Overrides FieldConfigInterface::setSettings
FieldConfigBase::setTranslatable public function Sets whether the field is translatable. Overrides FieldConfigInterface::setTranslatable
FieldConfigBase::__sleep public function Implements the magic __sleep() method. Overrides ConfigEntityBase::__sleep 1
FieldInputValueNormalizerTrait::normalizeValue protected static function Ensure a field value is transformed into a format keyed by delta.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.