class FieldStorageDefinition

Same name in other branches
  1. 9 core/modules/system/tests/modules/entity_test/src/FieldStorageDefinition.php \Drupal\entity_test\FieldStorageDefinition
  2. 8.9.x core/modules/system/tests/modules/entity_test/src/FieldStorageDefinition.php \Drupal\entity_test\FieldStorageDefinition
  3. 10 core/modules/system/tests/modules/entity_test/src/FieldStorageDefinition.php \Drupal\entity_test\FieldStorageDefinition

A custom field storage definition class.

For convenience we extend from BaseFieldDefinition although this should not implement FieldDefinitionInterface.

@todo Provide and make use of a proper FieldStorageDefinition class instead: https://www.drupal.org/node/2280639.

Hierarchy

Expanded class hierarchy of FieldStorageDefinition

6 files declare their use of FieldStorageDefinition
EntityDefinitionTestTrait.php in core/modules/system/tests/src/Functional/Entity/Traits/EntityDefinitionTestTrait.php
EntityDefinitionUpdateTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityDefinitionUpdateTest.php
EntitySchemaTestHooks.php in core/modules/system/tests/modules/entity_schema_test/src/Hook/EntitySchemaTestHooks.php
EntityTestBaseFieldDisplay.php in core/modules/system/tests/modules/entity_test/src/Entity/EntityTestBaseFieldDisplay.php
EntityTestComputedBundleField.php in core/modules/system/tests/modules/entity_test/src/Entity/EntityTestComputedBundleField.php

... See full list

File

core/modules/system/tests/modules/entity_test/src/FieldStorageDefinition.php, line 18

Namespace

Drupal\entity_test
View source
class FieldStorageDefinition extends BaseFieldDefinition {
    
    /**
     * {@inheritdoc}
     */
    public function isBaseField() {
        return FALSE;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BaseFieldDefinition::$indexes protected property
BaseFieldDefinition::$propertyDefinitions protected property An array of field property definitions.
BaseFieldDefinition::$schema protected property The field schema.
BaseFieldDefinition::$type protected property The field type.
BaseFieldDefinition::addPropertyConstraints public function Adds constraints for a given field item property.
BaseFieldDefinition::create public static function Creates a new field definition. Overrides ListDataDefinition::create 1
BaseFieldDefinition::createFromFieldStorageDefinition public static function Creates a new field definition based upon a field storage definition.
BaseFieldDefinition::createFromItemType public static function Overrides ListDataDefinition::createFromItemType
BaseFieldDefinition::getCardinality public function Overrides FieldStorageDefinitionInterface::getCardinality
BaseFieldDefinition::getColumns public function Overrides FieldStorageDefinitionInterface::getColumns
BaseFieldDefinition::getConfig public function Overrides FieldDefinitionInterface::getConfig
BaseFieldDefinition::getDefaultValue public function Overrides FieldDefinitionInterface::getDefaultValue
BaseFieldDefinition::getDefaultValueCallback public function Overrides FieldDefinitionInterface::getDefaultValueCallback
BaseFieldDefinition::getDefaultValueLiteral public function Overrides FieldDefinitionInterface::getDefaultValueLiteral
BaseFieldDefinition::getDisplayOptions public function Overrides FieldDefinitionInterface::getDisplayOptions
BaseFieldDefinition::getFieldStorageDefinition public function Overrides FieldDefinitionInterface::getFieldStorageDefinition
BaseFieldDefinition::getInitialValue public function Returns the initial value for the field.
BaseFieldDefinition::getInitialValueFromField public function Returns the name of the field that will be used for getting initial values.
BaseFieldDefinition::getMainPropertyName public function Overrides FieldStorageDefinitionInterface::getMainPropertyName
BaseFieldDefinition::getName public function Overrides FieldDefinitionInterface::getName
BaseFieldDefinition::getOptionsProvider public function Overrides FieldStorageDefinitionInterface::getOptionsProvider
BaseFieldDefinition::getPropertyDefinition public function Overrides FieldStorageDefinitionInterface::getPropertyDefinition
BaseFieldDefinition::getPropertyDefinitions public function Overrides FieldStorageDefinitionInterface::getPropertyDefinitions
BaseFieldDefinition::getPropertyNames public function Overrides FieldStorageDefinitionInterface::getPropertyNames
BaseFieldDefinition::getProvider public function Overrides FieldStorageDefinitionInterface::getProvider
BaseFieldDefinition::getSchema public function Overrides FieldStorageDefinitionInterface::getSchema
BaseFieldDefinition::getSetting public function Overrides DataDefinition::getSetting
BaseFieldDefinition::getSettings public function Overrides DataDefinition::getSettings 1
BaseFieldDefinition::getTargetBundle public function Overrides FieldDefinitionInterface::getTargetBundle
BaseFieldDefinition::getTargetEntityTypeId public function Overrides FieldDefinitionInterface::getTargetEntityTypeId
BaseFieldDefinition::getType public function Overrides FieldDefinitionInterface::getType 1
BaseFieldDefinition::getUniqueIdentifier public function Overrides FieldDefinitionInterface::getUniqueIdentifier
BaseFieldDefinition::getUniqueStorageIdentifier public function Overrides FieldStorageDefinitionInterface::getUniqueStorageIdentifier
BaseFieldDefinition::hasCustomStorage public function Overrides FieldStorageDefinitionInterface::hasCustomStorage
BaseFieldDefinition::isDeleted public function Overrides FieldStorageDefinitionInterface::isDeleted
BaseFieldDefinition::isDisplayConfigurable public function Overrides FieldDefinitionInterface::isDisplayConfigurable
BaseFieldDefinition::isInternal public function Overrides DataDefinition::isInternal
BaseFieldDefinition::isMultiple public function Overrides FieldStorageDefinitionInterface::isMultiple
BaseFieldDefinition::isRevisionable public function Overrides FieldStorageDefinitionInterface::isRevisionable
BaseFieldDefinition::isStorageRequired public function Overrides RequiredFieldStorageDefinitionInterface::isStorageRequired
BaseFieldDefinition::isTranslatable public function Overrides FieldDefinitionInterface::isTranslatable
BaseFieldDefinition::setCardinality public function Sets the maximum number of items allowed for the field.
BaseFieldDefinition::setCustomStorage public function Sets the storage behavior for this field.
BaseFieldDefinition::setDefaultValue public function
BaseFieldDefinition::setDefaultValueCallback public function
BaseFieldDefinition::setDeleted public function Sets whether the field storage is deleted.
BaseFieldDefinition::setDisplayConfigurable public function Sets whether the display for the field can be configured.
BaseFieldDefinition::setDisplayOptions public function Sets the display options for the field in forms or rendered entities.
BaseFieldDefinition::setInitialValue public function Sets an initial value for the field.
BaseFieldDefinition::setInitialValueFromField public function Sets a field that will be used for getting initial values.
BaseFieldDefinition::setName public function Sets the field name.
BaseFieldDefinition::setPropertyConstraints public function Sets constraints for a given field item property.
BaseFieldDefinition::setProvider public function Sets the name of the provider of this field.
BaseFieldDefinition::setRevisionable public function Sets whether the field is revisionable.
BaseFieldDefinition::setSetting public function Overrides DataDefinition::setSetting
BaseFieldDefinition::setSettings public function Note that the method does not unset existing settings not specified in the
incoming $settings array.
Overrides DataDefinition::setSettings
BaseFieldDefinition::setStorageRequired public function Sets whether the field storage is required.
BaseFieldDefinition::setTargetBundle public function Sets the bundle this field is defined for.
BaseFieldDefinition::setTargetEntityTypeId public function Sets the ID of the type of the entity this field is attached to.
BaseFieldDefinition::setTranslatable public function Sets whether the field is translatable. Overrides FieldStorageDefinitionInterface::setTranslatable
BaseFieldDefinition::__clone public function Magic method: Implements a deep clone. Overrides ListDataDefinition::__clone
BaseFieldDefinition::__sleep public function Overrides DataDefinition::__sleep
DataDefinition::$definition protected property The array holding values for all definition keys.
DataDefinition::addConstraint public function Overrides DataDefinitionInterface::addConstraint
DataDefinition::getConstraint public function Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints public function Overrides DataDefinitionInterface::getConstraints 1
DataDefinition::getDescription public function Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel public function Overrides DataDefinitionInterface::getLabel 1
DataDefinition::isComputed public function Overrides DataDefinitionInterface::isComputed
DataDefinition::isList public function Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly public function Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired public function Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists public function This is for BC support only.
DataDefinition::offsetGet public function This is for BC support only.
DataDefinition::offsetSet public function This is for BC support only.
DataDefinition::offsetUnset public function This is for BC support only.
DataDefinition::setClass public function Sets the class used for creating the typed data object.
DataDefinition::setComputed public function Sets whether the data is computed.
DataDefinition::setConstraints public function Sets an array of validation constraints.
DataDefinition::setDescription public function Sets the human-readable description.
DataDefinition::setInternal public function Sets the whether the data value should be internal.
DataDefinition::setLabel public function Sets the human-readable label.
DataDefinition::setReadOnly public function Sets whether the data is read-only.
DataDefinition::setRequired public function Sets whether the data is required.
DataDefinition::toArray public function Returns all definition values as array.
FieldInputValueNormalizerTrait::normalizeValue protected static function Ensure a field value is transformed into a format keyed by delta.
FieldStorageDefinition::isBaseField public function Overrides BaseFieldDefinition::isBaseField
FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED constant Value indicating a field accepts an unlimited number of values.
ListDataDefinition::$itemDefinition protected property The data definition of a list item.
ListDataDefinition::createFromDataType public static function Overrides DataDefinition::createFromDataType
ListDataDefinition::getClass public function Overrides DataDefinition::getClass
ListDataDefinition::getDataType public function Overrides DataDefinition::getDataType 1
ListDataDefinition::getItemDefinition public function Overrides ListDataDefinitionInterface::getItemDefinition
ListDataDefinition::setDataType public function Overrides DataDefinition::setDataType
ListDataDefinition::setItemDefinition public function Sets the item definition.
ListDataDefinition::__construct public function Overrides DataDefinition::__construct
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2
UnchangingCacheableDependencyTrait::getCacheContexts public function 1
UnchangingCacheableDependencyTrait::getCacheMaxAge public function 3
UnchangingCacheableDependencyTrait::getCacheTags public function 1

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