Docs4dev
Docs

class BaseFieldOverride

Defines the base field override entity.

Allows base fields to be overridden on the bundle level.

Plugin annotation

@ConfigEntityType(
  id = "base_field_override",
  label = @Translation("Base field override"),
  handlers = {
    "storage" = "Drupal\Core\Field\BaseFieldOverrideStorage"
  },
  config_prefix = "base_field_override",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "field_name",
    "entity_type",
    "bundle",
    "label",
    "description",
    "required",
    "translatable",
    "default_value",
    "default_value_callback",
    "settings",
    "field_type",
  }
)

Hierarchy

File

core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php, line 42

Namespace

Drupal\Core\Field\Entity

Members

Name Modifiers Type Description
BaseFieldOverride::$baseFieldDefinition protected property The base field definition.
BaseFieldOverride::createFromBaseFieldDefinition public static function Creates a base field override object.
BaseFieldOverride::getBaseFieldDefinition protected function Gets the base field definition.
BaseFieldOverride::getDisplayOptions public function Returns the default display options for the field. Overrides FieldDefinitionInterface::getDisplayOptions
BaseFieldOverride::getFieldStorageDefinition public function Returns the field storage definition. Overrides FieldDefinitionInterface::getFieldStorageDefinition
BaseFieldOverride::isComputed public function Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
BaseFieldOverride::isDisplayConfigurable public function Returns whether the display for the field can be configured. Overrides FieldDefinitionInterface::isDisplayConfigurable
BaseFieldOverride::isReadOnly public function Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
BaseFieldOverride::loadByName public static function Loads a base field bundle override config entity.
BaseFieldOverride::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides Entity::postDelete
BaseFieldOverride::preSave public function Overrides ConfigEntityBase::preSave
BaseFieldOverride::__construct public function Constructs a BaseFieldOverride object. Overrides ConfigEntityBase::__construct
BaseFieldOverride::__sleep public function Implements the magic __sleep() method. Overrides FieldConfigBase::__sleep
ConfigEntityBase::$isSyncing private property Whether the config is being created, updated or deleted through the import process.
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.
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 Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides Entity::createDuplicate
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable
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 Entity::getCacheTagsToInvalidate
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides Entity::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 Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing public function Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides Entity::preDelete
ConfigEntityBase::save public function Saves an entity permanently. Overrides Entity::save
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setSyncing public function Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
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.
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides Entity::toArray
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides Entity::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
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides Entity::urlInfo
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep
DependencySerializationTrait::__wakeup public function
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
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId protected property The entity type.
Entity::$typedData protected property A typed data object wrapping this entity.
Entity::access public function Checks data value access. Overrides AccessibleInterface::access
Entity::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
Entity::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
Entity::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
Entity::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated protected function Gets the entity manager.
Entity::entityTypeManager protected function Gets the entity type manager.
Entity::getCacheContexts public function The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags public function The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::label public function Gets the label of the entity. Overrides EntityInterface::label
Entity::language public function Gets the language of the entity. Overrides EntityInterface::language
Entity::languageManager protected function Gets the language manager.
Entity::linkTemplates protected function Gets an array link templates.
Entity::load public static function Loads an entity. Overrides EntityInterface::load
Entity::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
Entity::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
Entity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
Entity::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
Entity::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters protected function Gets an array of placeholders for this entity.
Entity::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
Entity::uuidGenerator protected function Gets the UUID generator.
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::$fieldStorage protected property The field storage object.
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::$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::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
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
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 Entity::id
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::postCreate public function Acts on a created entity before hooks are invoked. Overrides Entity::postCreate
FieldConfigBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides Entity::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 [@inheritdoc} 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
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance.
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyTrait::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyTrait::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Field!Entity!BaseFieldOverride.php/class/BaseFieldOverride/8.1.x