- ⧉⌕Drupal\custom_landing\Entity\Node#1822 (30)
- Properties (30)
- Available methods (146)
- Static class properties (10)
- protected entityTypeId -> string (4) "node"
- protected enforceIsNew -> null
- protected typedData -> null
- protected cacheContexts -> array (0)
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- ⧉protected values -> array (27)
- ⧉nid => array (1)
- x-default => string (2) "79"
- ⧉vid => array (1)
- x-default => string (4) "3376"
- ⧉type => array (1)
- x-default => string (13) "home_minisite"
- ⧉uuid => array (1)
- x-default => string (36) "4bf51466-1519-40bd-ba2f-b1c024d57a87"
- ⧉langcode => array (1)
- x-default => string (2) "fr"
- ⧉revision_uid => array (1)
- x-default => string (2) "54"
- ⧉revision_timestamp => array (1)
- ⧉x-default => string (10) "1751638476"
2025-07-04 14:14:36 UTC
- ⧉revision_log => array (1)
- x-default => null
- ⧉revision_default => array (1)
- x-default => string (1) "1"
- ⧉isDefaultRevision => array (1)
- x-default => string (1) "1"
- ⧉status => array (1)
- x-default => string (1) "1"
- ⧉uid => array (1)
- x-default => string (1) "1"
- ⧉title => array (1)
- x-default => string (29) "[DER Biologie] Page d'accueil"
- ⧉created => array (1)
- ⧉x-default => string (10) "1738927407"
2025-02-07 11:23:27 UTC
- ⧉changed => array (1)
- ⧉x-default => string (10) "1751638476"
2025-07-04 14:14:36 UTC
- ⧉promote => array (1)
- x-default => string (1) "0"
- ⧉sticky => array (1)
- x-default => string (1) "0"
- ⧉default_langcode => array (1)
- x-default => string (1) "1"
- ⧉revision_translation_affected => array (1)
- x-default => null
- ⧉published_at => array (1)
- ⧉x-default => string (10) "1738927456"
2025-02-07 11:24:16 UTC
- ⧉publish_on => array (1)
- x-default => null
- ⧉unpublish_on => array (1)
- x-default => null
- ⧉content_translation_source => array (1)
- x-default => string (3) "und"
- ⧉content_translation_outdated => array (1)
- x-default => string (1) "0"
- ⧉publish_state => array (1)
- x-default => null
- ⧉unpublish_state => array (1)
- x-default => null
- ⧉content => array (1)
- ⧉x-default => array (4)
- ⧉0 => array (2) Depth Limit
- ⧉1 => array (2) Depth Limit
- ⧉2 => array (2) Depth Limit
- ⧉3 => array (2) Depth Limit
- protected fields -> array (0)
- ⧉protected fieldDefinitions -> array (34)
- ⧉nid => Drupal\Core\Field\BaseFieldDefinition#2344 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (6)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2347 (5) Depth Limit
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (3) "nid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2348 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2344 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "integer"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉uuid => Drupal\Core\Field\BaseFieldDefinition#2349 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (6)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2350 (5) Depth Limit
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (4) "uuid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2351 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2349 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (4) "uuid"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉vid => Drupal\Core\Field\BaseFieldDefinition#2352 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (6)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2353 (5) Depth Limit
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (3) "vid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2354 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2352 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "integer"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉langcode => Drupal\Core\Field\BaseFieldDefinition#2355 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (8)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2356 (5) Depth Limit
- ⧉display => array (2) Depth Limit
- revisionable => boolean true
- translatable => boolean true
- provider => string (4) "node"
- field_name => string (8) "langcode"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2357 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2355 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (8) "language"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉type => Drupal\Core\Field\BaseFieldDefinition#2358 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (7)
- label => string (15) "Type de contenu"
- required => boolean true
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (4) "type"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2359 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2358 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉revision_timestamp => Drupal\Core\Field\BaseFieldDefinition#2360 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (7)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2361 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2362 (5) Depth Limit
- revisionable => boolean true
- provider => string (4) "node"
- field_name => string (18) "revision_timestamp"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2363 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2360 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "created"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉revision_uid => Drupal\Core\Field\BaseFieldDefinition#2364 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (7)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2365 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2366 (5) Depth Limit
- revisionable => boolean true
- provider => string (4) "node"
- field_name => string (12) "revision_uid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2367 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2364 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉revision_log => Drupal\Core\Field\BaseFieldDefinition#2368 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2369 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2370 (5) Depth Limit
- revisionable => boolean true
- ⧉default_value => array (1) Depth Limit
- ⧉display => array (1) Depth Limit
- provider => string (4) "node"
- field_name => string (12) "revision_log"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2371 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2368 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (11) "string_long"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉status => Drupal\Core\Field\Entity\BaseFieldOverride#2476 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (25) "node.home_minisite.status"
- protected status -> boolean true
- protected uuid -> string (36) "97966f0e-fda7-48d2-a656-c5bb5490f088"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (25) "node.home_minisite.status"
- protected field_name -> string (6) "status"
- protected field_type -> string (7) "boolean"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> UTF-8 string (7) "Publié"
- protected description -> string (0) ""
- ⧉protected settings -> array (2)
- on_label => UTF-8 string (7) "Activé"
- off_label => UTF-8 string (11) "Désactivé"
- protected required -> boolean false
- protected translatable -> boolean true
- ⧉protected default_value -> array (1)
- ⧉0 => array (1) Depth Limit
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2372 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2374 (3) Depth Limit
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉uid => Drupal\Core\Field\Entity\BaseFieldOverride#2477 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (22) "node.home_minisite.uid"
- protected status -> boolean true
- protected uuid -> string (36) "0f9bc305-af6f-45b9-8ce5-247d4e8aabc9"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (22) "node.home_minisite.uid"
- protected field_name -> string (3) "uid"
- protected field_type -> string (16) "entity_reference"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> UTF-8 string (10) "Écrit par"
- protected description -> string (44) "Le nom d'utilisateur de l'auteur du contenu."
- ⧉protected settings -> array (2)
- handler => string (7) "default"
- handler_settings => array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (56) "Drupal\custom_landing\Entity\Node::getDefaultEntityOwner"
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2377 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (10) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2380 (3) Depth Limit
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉title => Drupal\Core\Field\Entity\BaseFieldOverride#2478 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (24) "node.home_minisite.title"
- protected status -> boolean true
- protected uuid -> string (36) "c8b18e33-bcef-4d29-bf1e-27e8da73dcdd"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (24) "node.home_minisite.title"
- protected field_name -> string (5) "title"
- protected field_type -> string (6) "string"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> string (5) "Titre"
- protected description -> string (0) ""
- protected settings -> array (0)
- protected required -> boolean true
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2381 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2383 (3) Depth Limit
- protected type -> string (6) "string"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉created => Drupal\Core\Field\Entity\BaseFieldOverride#2479 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (26) "node.home_minisite.created"
- protected status -> boolean true
- protected uuid -> string (36) "a17f8c11-40db-4ef2-9e14-d0b140bd1b28"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (26) "node.home_minisite.created"
- protected field_name -> string (7) "created"
- protected field_type -> string (7) "created"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> UTF-8 string (9) "Écrit le"
- protected description -> UTF-8 string (44) "L'heure à laquelle le nœud a été créé."
- protected settings -> array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2384 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2387 (3) Depth Limit
- protected type -> string (7) "created"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉changed => Drupal\Core\Field\Entity\BaseFieldOverride#2480 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (26) "node.home_minisite.changed"
- protected status -> boolean true
- protected uuid -> string (36) "c471dc68-4df7-4d29-89f1-b82a97716ada"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (26) "node.home_minisite.changed"
- protected field_name -> string (7) "changed"
- protected field_type -> string (7) "changed"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> UTF-8 string (8) "Modifié"
- protected description -> UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- protected settings -> array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2388 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (8) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2391 (3) Depth Limit
- protected type -> string (7) "changed"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉promote => Drupal\Core\Field\Entity\BaseFieldOverride#2481 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (26) "node.home_minisite.promote"
- protected status -> boolean true
- protected uuid -> string (36) "c162b3a3-a3f2-42dd-9214-9f6077c63f7a"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- ⧉protected _core -> array (1)
- default_config_hash => string (43) "oV1hCmjm_4WVfoCKNEPnBz5yY4X_boPB4HmoJ5hD43M"
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (26) "node.home_minisite.promote"
- protected field_name -> string (7) "promote"
- protected field_type -> string (7) "boolean"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> string (23) "Promu en page d'accueil"
- protected description -> string (0) ""
- ⧉protected settings -> array (2)
- on_label => UTF-8 string (7) "Activé"
- off_label => UTF-8 string (11) "Désactivé"
- protected required -> boolean false
- protected translatable -> boolean true
- ⧉protected default_value -> array (1)
- ⧉0 => array (1) Depth Limit
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2392 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2394 (3) Depth Limit
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉sticky => Drupal\Core\Field\Entity\BaseFieldOverride#2482 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (25) "node.home_minisite.sticky"
- protected status -> boolean true
- protected uuid -> string (36) "5b4d0455-66c0-48ee-89ee-8ad0b6ccbdca"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (25) "node.home_minisite.sticky"
- protected field_name -> string (6) "sticky"
- protected field_type -> string (7) "boolean"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> UTF-8 string (27) "Epinglé en haut des listes"
- protected description -> string (0) ""
- ⧉protected settings -> array (2)
- on_label => UTF-8 string (7) "Activé"
- off_label => UTF-8 string (11) "Désactivé"
- protected required -> boolean false
- protected translatable -> boolean true
- ⧉protected default_value -> array (1)
- ⧉0 => array (1) Depth Limit
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2397 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2399 (3) Depth Limit
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉default_langcode => Drupal\Core\Field\BaseFieldDefinition#2402 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2403 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2404 (5) Depth Limit
- translatable => boolean true
- revisionable => boolean true
- ⧉default_value => array (1) Depth Limit
- provider => string (4) "node"
- field_name => string (16) "default_langcode"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2405 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2402 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉revision_default => Drupal\Core\Field\BaseFieldDefinition#2408 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (10)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2409 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2410 (5) Depth Limit
- storage_required => boolean true
- internal => boolean true
- translatable => boolean false
- revisionable => boolean true
- provider => string (4) "node"
- field_name => string (16) "revision_default"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2411 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2408 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "boolean"
- ⧉protected propertyDefinitions -> array (1)
- ⧉value => Drupal\Core\TypedData\DataDefinition#2346 (2) Depth Limit
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉revision_translation_affected => Drupal\Core\Field\BaseFieldDefinition#2414 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2415 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2416 (5) Depth Limit
- read-only => boolean true
- revisionable => boolean true
- translatable => boolean true
- provider => string (4) "node"
- field_name => string (29) "revision_translation_affected"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2417 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2414 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉moderation_state => Drupal\Core\Field\BaseFieldDefinition#2486 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (12)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2487 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2488 (5) Depth Limit
- computed => boolean true
- class => string (67) "Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList"
- ⧉display => array (2) Depth Limit
- ⧉constraints => array (1) Depth Limit
- read-only => boolean false
- translatable => boolean true
- provider => string (18) "content_moderation"
- field_name => string (16) "moderation_state"
- entity_type => string (4) "node"
- bundle => string (13) "home_minisite"
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2489 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2486 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (6) "string"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉entitygroupfield => Drupal\Core\Field\BaseFieldDefinition#2424 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (11)
- ⧉field_name => string (16) "entitygroupfield"
- Base64
- base64_decode(field_name) binary string (12)
- entity_type => string (4) "node"
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2425 (5) Depth Limit
- translatable => boolean false
- computed => boolean true
- custom_storage => boolean true
- cardinality => integer -1
- class => string (55) "\Drupal\entitygroupfield\Field\EntityGroupFieldItemList"
- ⧉display => array (2) Depth Limit
- ⧉provider => string (16) "entitygroupfield"
- Base64
- base64_decode(provider) binary string (12)
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2426 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2424 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- ⧉protected type -> string (16) "entitygroupfield"
- Base64
- base64_decode(type) binary string (12)
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉groups => Drupal\Core\Field\BaseFieldDefinition#2427 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (12)
- field_name => string (6) "groups"
- entity_type => string (4) "node"
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2428 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2429 (5) Depth Limit
- translatable => boolean false
- computed => boolean true
- custom_storage => boolean true
- cardinality => integer -1
- class => string (54) "\Drupal\gcontent\Fields\GcontentGroupReferenceItemList"
- ⧉display => array (2) Depth Limit
- provider => string (5) "group"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2430 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2427 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉groups_type_main => Drupal\Core\Field\BaseFieldDefinition#2431 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (12)
- field_name => string (16) "groups_type_main"
- entity_type => string (4) "node"
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2432 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2433 (5) Depth Limit
- translatable => boolean false
- computed => boolean true
- custom_storage => boolean true
- cardinality => integer -1
- class => string (54) "\Drupal\gcontent\Fields\GcontentGroupReferenceItemList"
- ⧉display => array (2) Depth Limit
- provider => string (5) "group"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2434 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2431 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉groups_type_minisite => Drupal\Core\Field\BaseFieldDefinition#2435 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (12)
- field_name => string (20) "groups_type_minisite"
- entity_type => string (4) "node"
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2436 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2437 (5) Depth Limit
- translatable => boolean false
- computed => boolean true
- custom_storage => boolean true
- cardinality => integer -1
- class => string (54) "\Drupal\gcontent\Fields\GcontentGroupReferenceItemList"
- ⧉display => array (2) Depth Limit
- provider => string (5) "group"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2438 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2435 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉metatag => Drupal\Core\Field\Entity\BaseFieldOverride#2483 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (26) "node.home_minisite.metatag"
- protected status -> boolean true
- protected uuid -> string (36) "6c3b0976-facb-496e-a525-addd60443f0b"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (26) "node.home_minisite.metatag"
- protected field_name -> string (7) "metatag"
- protected field_type -> string (3) "map"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> string (8) "Metatags"
- protected description -> string (29) "The meta tags for the entity."
- protected settings -> array (0)
- protected required -> boolean false
- protected translatable -> boolean false
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2439 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2442 (3) Depth Limit
- protected type -> string (3) "map"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉path => Drupal\Core\Field\Entity\BaseFieldOverride#2484 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (23) "node.home_minisite.path"
- protected status -> boolean true
- protected uuid -> string (36) "7ae6835e-b280-49cd-a4b8-45c260ea6904"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (2)
- ⧉config => array (1) Depth Limit
- ⧉module => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (23) "node.home_minisite.path"
- protected field_name -> string (4) "path"
- protected field_type -> string (4) "path"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> string (11) "Alias d'URL"
- protected description -> string (0) ""
- protected settings -> array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2443 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (8) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2445 (3) Depth Limit
- protected type -> string (4) "path"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉publish_on => Drupal\Core\Field\Entity\BaseFieldOverride#2485 (35)
- Properties (36)
- Available methods (133)
- public original -> undefined
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (29) "node.home_minisite.publish_on"
- protected status -> boolean true
- protected uuid -> string (36) "9e2c4bbd-3e26-40b2-a5cd-0d03a0d60128"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1)
- ⧉config => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (29) "node.home_minisite.publish_on"
- protected field_name -> string (10) "publish_on"
- protected field_type -> string (9) "timestamp"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> string (10) "Publish on"
- protected description -> string (0) ""
- protected settings -> array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- ⧉protected baseFieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2446 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2448 (3) Depth Limit
- protected type -> string (9) "timestamp"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:135
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:143
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- ⧉public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:159
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:167
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:175
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:201
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:277
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:185
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.\Drupal\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle)
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}\Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:239
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.\Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name)
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:270
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉unpublish_on => Drupal\Core\Field\BaseFieldDefinition#2449 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2450 (5) Depth Limit
- ⧉display => array (1) Depth Limit
- translatable => boolean true
- revisionable => boolean true
- ⧉constraints => array (1) Depth Limit
- provider => string (9) "scheduler"
- field_name => string (12) "unpublish_on"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2451 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2449 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (9) "timestamp"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉publish_state => Drupal\Core\Field\BaseFieldDefinition#2452 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2453 (5) Depth Limit
- ⧉display => array (2) Depth Limit
- translatable => boolean true
- revisionable => boolean true
- ⧉constraints => array (2) Depth Limit
- provider => string (40) "scheduler_content_moderation_integration"
- field_name => string (13) "publish_state"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2454 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2452 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (11) "list_string"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉unpublish_state => Drupal\Core\Field\BaseFieldDefinition#2455 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2456 (5) Depth Limit
- ⧉display => array (2) Depth Limit
- translatable => boolean true
- revisionable => boolean true
- ⧉constraints => array (2) Depth Limit
- provider => string (40) "scheduler_content_moderation_integration"
- field_name => string (15) "unpublish_state"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2457 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2455 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (11) "list_string"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉menu_link => Drupal\Core\Field\BaseFieldDefinition#2458 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (12)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2459 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2460 (5) Depth Limit
- revisionable => boolean true
- class => string (35) "\Drupal\token\MenuLinkFieldItemList"
- translatable => boolean true
- internal => boolean true
- ⧉display => array (2) Depth Limit
- computed => boolean true
- provider => string (5) "token"
- field_name => string (9) "menu_link"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2461 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2458 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉content_translation_source => Drupal\Core\Field\BaseFieldDefinition#2462 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (10)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2463 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2464 (5) Depth Limit
- ⧉default_value => array (1) Depth Limit
- ⧉initial_value => array (1) Depth Limit
- revisionable => boolean true
- translatable => boolean true
- provider => string (19) "content_translation"
- field_name => string (26) "content_translation_source"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2465 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2462 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (8) "language"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉content_translation_outdated => Drupal\Core\Field\BaseFieldDefinition#2466 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (10)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2467 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2468 (5) Depth Limit
- ⧉default_value => array (1) Depth Limit
- ⧉initial_value => array (1) Depth Limit
- revisionable => boolean true
- translatable => boolean true
- provider => string (19) "content_translation"
- field_name => string (28) "content_translation_outdated"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2469 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2466 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉published_at => Drupal\Core\Field\BaseFieldDefinition#2472 (7)
- Properties (7)
- Available methods (94)
- Static class properties
- ⧉protected definition -> array (9)
- ⧉label => Drupal\Core\StringTranslation\TranslatableMarkup#2473 (5) Depth Limit
- ⧉description => Drupal\Core\StringTranslation\TranslatableMarkup#2474 (5) Depth Limit
- revisionable => boolean true
- translatable => boolean true
- ⧉display => array (2) Depth Limit
- provider => string (16) "publication_date"
- field_name => string (12) "published_at"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- ⧉protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2475 (3)
- Properties (3)
- Available methods (41)
- ⧉protected definition -> array (2) Depth Limit
- protected typedDataManager -> null
- ⧉protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2472 (7) Recursion
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
- ⧉public getFieldDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
- ⧉public setFieldDefinition($field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
- ⧉public getLabel(): string Gets the label of the field type.
/** * Gets the label of the field type. * * If the label hasn't been set, then fall back to the label of the * typed data definition. * * @return string * The label of the field type. * * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public __construct(array $values = array()) Constructs a new data definition object.
/** * Constructs a new data definition object. * * @param array $values * (optional) If given, an array of initial values to set on the definition. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
- ⧉public setDataType($type): static Sets the data type.
/** * Sets the data type. * * @param string $type * The data type to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
- ⧉public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/** * Sets the array of settings, as required by the used class. * * @param array $settings * The array of settings. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
- ⧉public setSetting($setting_name, $value): static Sets a definition setting.
/** * Sets a definition setting. * * @param string $setting_name * The definition setting to set. * @param mixed $value * The value to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static createFromDataType($data_type) {@inheritdoc}\Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
- ⇄⧉public static create($field_definition): static Creates a new field item definition.\Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition)
/** * Creates a new field item definition. * * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * The field definition the item definition belongs to. * * @return static */ Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
- protected type -> string (12) "published_at"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
- ⧉public setName($name): static Sets the field name.
/** * Sets the field name. * * @param string $name * The field name to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} * * Note that the method does not unset existing settings not specified in the * incoming $settings array. * * For example: * @code * // Given these are the default settings. * $field_definition->getSettings() === [ * 'fruit' => 'apple', * 'season' => 'summer', * ]; * // Change only the 'fruit' setting. * $field_definition->setSettings(['fruit' => 'banana']); * // The 'season' setting persists unchanged. * $field_definition->getSettings() === [ * 'fruit' => 'banana', * 'season' => 'summer', * ]; * @endcode * * For clarity, it is preferred to use setSetting() if not all available * settings are supplied. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
- ⧉public setProvider($provider): $this Sets the name of the provider of this field.
/** * Sets the name of the provider of this field. * * @param string $provider * The provider name to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
- ⧉public setTranslatable($translatable): $this Sets whether the field is translatable.
/** * Sets whether the field is translatable. * * @param bool $translatable * Whether the field is translatable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
- ⧉public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/** * Sets whether the field is revisionable. * * @param bool $revisionable * Whether the field is revisionable. * * @return $this * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
- ⧉public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/** * Sets the maximum number of items allowed for the field. * * Possible values are positive integers or * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED. * * Note that if the entity type that this base field is attached to is * revisionable and the field has a cardinality higher than 1, the field is * considered revisionable by default. * * @param int $cardinality * The field cardinality. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
- ⧉public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/** * Sets constraints for a given field item property. * * Note: this overwrites any existing property constraints. If you need to * add to the existing constraints, use * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints() * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
- ⧉public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/** * Adds constraints for a given field item property. * * Adds a constraint to a property of a base field item. e.g. * @code * // Limit the field item's value property to the range 0 through 10. * // e.g. $node->size->value. * $field->addPropertyConstraints('value', [ * 'Range' => [ * 'min' => 0, * 'max' => 10, * ] * ]); * @endcode * * If you want to add a validation constraint that applies to the * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint() * instead. * * Note: passing a new set of options for an existing property constraint will * overwrite with the new options. * * @param string $name * The name of the property to set constraints for. * @param array $constraints * The constraints to set. * * @return static * The object itself for chaining. * * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint() */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
- ⧉public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/** * Sets the display options for the field in forms or rendered entities. * * This enables generic rendering of the field with widgets / formatters, * including automated support for "In place editing", and with optional * configurability in the "Manage display" / "Manage form display" UI screens. * * Unless this method is called, the field remains invisible (or requires * ad-hoc rendering logic). * * @param string $display_context * The display context. Either 'view' or 'form'. * @param array $options * An array of display options. Refer to * \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for * a list of supported keys. The options should include at least a 'weight', * or specify 'region' = 'hidden'. The 'default_widget' / * 'default_formatter' for the field type will be used if no 'type' is * specified. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
- ⧉public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/** * Sets whether the display for the field can be configured. * * @param string $display_context * The display context. Either 'view' or 'form'. * @param bool $configurable * Whether the display options can be configured (e.g., via the "Manage * display" / "Manage form display" UI screens). If TRUE, the options * specified via getDisplayOptions() act as defaults. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- ⧉public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
- ⧉public getInitialValue(): array Returns the initial value for the field.
/** * Returns the initial value for the field. * * @return array * The initial value for the field, as a numerically indexed array of items, * each item being a property/value array (array() for no default value). */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:491
- ⧉public setInitialValue($value): $this Sets an initial value for the field.
/** * Sets an initial value for the field. * * @param mixed $value * The initial value for the field. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:510
- ⧉public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/** * Returns the name of the field that will be used for getting initial values. * * @return string|null * The field name. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:527
- ⧉public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/** * Sets a field that will be used for getting initial values. * * @param string $field_name * The name of the field that will be used for getting initial values. * @param mixed $default_value * (optional) The default value for the field, in case the inherited value * is NULL. This can be either: * - a literal, in which case it will be assigned to the first property of * the first item; * - a numerically indexed array of items, each item being a property/value * array; * - a non-numerically indexed array, in which case the array is assumed to * be a property/value array and used as the first item; * - an empty array for no initial value. * If the field being added is required or an entity key, it is recommended * to provide a default value. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623
- ⧉public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/** * Sets the ID of the type of the entity this field is attached to. * * @param string $entity_type_id * The name of the target entity type to set. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
- ⧉public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/** * Sets the bundle this field is defined for. * * @param string|null $bundle * The bundle, or NULL if the field is not bundle-specific. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705
- ⧉public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/** * Sets the storage behavior for this field. * * @param bool $custom_storage * Pass FALSE if the storage takes care of storing the field, * TRUE otherwise. * * @return $this * * @throws \LogicException * Thrown if custom storage is to be set to FALSE for a computed field. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759
- ⧉public setDeleted($deleted): $this Sets whether the field storage is deleted.
/** * Sets whether the field storage is deleted. * * @param bool $deleted * Whether the field storage is deleted. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- ⧉public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790
- ⧉public setStorageRequired($required): static Sets whether the field storage is required.
/** * Sets whether the field storage is required. * * @param bool $required * Whether the field storage is required. * * @return static * The object itself for chaining. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- ⧉public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833
- ⧉public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- ⧉public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
- ⧉public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/** * Sets the item definition. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * A list item's data definition. * * @return $this */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- ⧉public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- ⧉public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
- ⧉public setLabel($label): static Sets the human-readable label.
/** * Sets the human-readable label. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label * The label to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
- ⧉public setDescription($description): static Sets the human-readable description.
/** * Sets the human-readable description. * * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description * The description to set. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
- ⧉public setReadOnly($read_only): static Sets whether the data is read-only.
/** * Sets whether the data is read-only. * * @param bool $read_only * Whether the data is read-only. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
- ⧉public setComputed($computed): static Sets whether the data is computed.
/** * Sets whether the data is computed. * * @param bool $computed * Whether the data is computed. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
- ⧉public setRequired($required): static Sets whether the data is required.
/** * Sets whether the data is required. * * @param bool $required * Whether the data is required. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
- ⧉public setClass($class): static Sets the class used for creating the typed data object.
/** * Sets the class used for creating the typed data object. * * @param string|null $class * The class to use. * * @return static * The object itself for chaining. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
- ⧉public setConstraints(array $constraints): $this Sets an array of validation constraints.
/** * Sets an array of validation constraints. * * @param array $constraints * An array of validation constraint definitions, keyed by constraint name. * Each constraint definition can be used for instantiating * \Symfony\Component\Validator\Constraint objects. * * @return $this */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
- ⧉public offsetExists($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
- ⧉public & offsetGet($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
- ⧉public offsetSet($offset, $value) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
- ⧉public offsetUnset($offset) {@inheritdoc}
/** * {@inheritdoc} * * This is for BC support only. * @todo Remove in https://www.drupal.org/node/1928868. */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
- ⧉public toArray(): array Returns all definition values as array.
/** * Returns all definition values as array. * * @return array */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
- ⧉public setInternal($internal): $this Sets the whether the data value should be internal.
/** * Sets the whether the data value should be internal. * * @param bool $internal * Whether the data value should be internal. * * @return $this * * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- ⇄⧉public static create($type): static Creates a new field definition.\Drupal\Core\Field\BaseFieldDefinition::create($type)
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- ⇄⧉public static createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.\Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition)
/** * Creates a new field definition based upon a field storage definition. * * In cases where one needs a field storage definitions to act like full * field definitions, this creates a new field definition based upon the * (limited) information available. That way it is possible to use the field * definition in places where a full field definition is required; e.g., with * widgets or formatters. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition to base the new field definition upon. * * @return $this */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type)
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\Core\Field\BaseFieldDefinition::CARDINALITY_UNLIMITED
- ⇄public const CARDINALITY_UNLIMITED :: integer -1
- ⧉content => Drupal\field\Entity\FieldConfig#2490 (35)
- Properties (36)
- Available methods (132)
- public original -> undefined
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (26) "node.home_minisite.content"
- protected status -> boolean true
- protected uuid -> string (36) "2b0c0653-dfdc-455a-80cf-fd7506f03c46"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- ⧉protected third_party_settings -> array (3)
- ⧉custom_lp => array (1) Depth Limit
- ⧉field_config_cardinality => array (5) Depth Limit
- ⧉gcontent => array (1) Depth Limit
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (2)
- ⧉config => array (6) Depth Limit
- ⧉module => array (4) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (26) "node.home_minisite.content"
- protected field_name -> string (7) "content"
- protected field_type -> string (26) "entity_reference_revisions"
- protected entity_type -> string (4) "node"
- protected bundle -> string (13) "home_minisite"
- protected label -> string (7) "Contenu"
- protected description -> string (0) ""
- ⧉protected settings -> array (2)
- handler => string (35) "default:group:strict:menu:paragraph"
- ⧉handler_settings => array (3) Depth Limit
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- ⧉protected fieldStorage -> Drupal\field\Entity\FieldStorageConfig#2492 (33)
- Properties (34)
- Available methods (129)
- Static class properties (3)
- public original -> undefined
- protected entityTypeId -> string (20) "field_storage_config"
- protected enforceIsNew -> null
- protected typedData -> null
- ⧉protected cacheContexts -> array (1) Depth Limit
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (12) "node.content"
- protected status -> boolean true
- protected uuid -> string (36) "8be1c04e-7a24-40d5-9d14-7f35609028e4"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- ⧉protected dependencies -> array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (12) "node.content"
- protected field_name -> string (7) "content"
- protected entity_type -> string (4) "node"
- protected type -> string (26) "entity_reference_revisions"
- protected module -> string (26) "entity_reference_revisions"
- ⧉protected settings -> array (1) Depth Limit
- protected cardinality -> integer -1
- protected translatable -> boolean true
- protected locked -> boolean false
- protected persist_with_no_fields -> boolean false
- public custom_storage -> boolean false
- protected indexes -> array (0)
- protected deleted -> boolean false
- ⧉protected schema -> array (4) Depth Limit
- protected propertyDefinitions -> null
- ⧉public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/** * Constructs a FieldStorageConfig object. * * In most cases, Field entities are created via * FieldStorageConfig::create($values)), where $values is the same parameter * as in this constructor. * * @param array $values * An array of field properties, keyed by property name. Most array * elements will be used to set the corresponding properties on the class; * see the class property documentation for details. Some array elements * have special meanings and a few are required. Special elements are: * - name: required. As a temporary Backwards Compatibility layer right now, * a 'field_name' property can be accepted in place of 'id'. * - entity_type: required. * - type: required. * @param string $entity_type * (optional) The entity type on which the field should be created. * Defaults to "field_storage_config". */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:262
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:283
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:290
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/** * 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. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:317
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:373
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:418
- ⧉public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:476
- ⧉public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:502
- ⧉public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:509
- ⧉public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:516
- ⧉public getBundles() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:524
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:537
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:544
- ⧉public getTypeProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:551
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:558
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:565
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:579
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:598
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:606
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:614
- ⧉public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:621
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:629
- ⧉public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:637
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:644
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:651
- ⧉public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:658
- ⧉public setCardinality($cardinality) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:675
- ⧉public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:683
- ⧉public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:710
- ⧉public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:718
- ⧉public setLocked($locked) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:725
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:733
- ⧉public hasData(): bool Determines whether a field has any data.
/** * Determines whether a field has any data. * * @return bool * TRUE if the field has data for any entity; FALSE otherwise. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:743
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. * * Using the Serialize interface and serialize() / unserialize() methods * breaks entity forms in PHP 5.4. * @todo Investigate in https://www.drupal.org/node/1977206. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:754
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:765
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:772
- ⧉public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:779
- ⧉public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:791
- ⧉public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:802
- ⧉public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:809
- ⧉public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:817
- ⧉public isDeletable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:849
- ⧉public getIndexes() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:859
- ⧉public setIndexes(array $indexes) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:866
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/** * Prepares saving a new field definition. * * @param \Drupal\Core\Entity\EntityStorageInterface $storage * The entity storage. * * @throws \Drupal\Core\Field\FieldException * If the field definition is invalid. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:347
- ⧉protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/** * Prepares saving an updated field definition. * * @param \Drupal\Core\Entity\EntityStorageInterface $storage * The entity storage. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:394
- ⧉protected getFieldItemClass() Helper to retrieve the field item class.
/** * Helper to retrieve the field item class. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:824
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}\Drupal\field\Entity\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages)
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:432
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}\Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields)
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:461
- ⇄⧉public static loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|null Loads a field config entity based on the entity type and field name.\Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name)
/** * 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 $field_name * Name of the field. * * @return \Drupal\field\FieldStorageConfigInterface|null * The field config entity if one exists for the provided field name, * otherwise NULL. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldStorageConfig.php:842
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- protected static $inDeletion :: boolean false
- ⇄public const NAME_MAX_LENGTH :: integer 32\Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH
- ⇄public const CARDINALITY_UNLIMITED :: integer -1\Drupal\field\Entity\FieldStorageConfig::CARDINALITY_UNLIMITED
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- protected deleted -> boolean false
- ⧉public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/** * 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". */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:108
- ⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:141
- ⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/** * 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. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:163
- ⧉public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:199
- ⧉public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:289
- ⧉public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:296
- ⧉public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:330
- ⧉public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:337
- ⧉public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:345
- ⧉public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:352
- ⧉public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:359
- ⧉public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- ⧉public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- ⧉public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- ⧉public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- ⧉public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
- ⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- ⧉public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:327
- ⧉public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:335
- ⧉public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:343
- ⧉public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
- ⧉public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
- ⧉public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:368
- ⧉public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:376
- ⧉public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:384
- ⧉public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:392
- ⧉public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:404
- ⧉public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:412
- ⧉public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:420
- ⧉public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:428
- ⧉public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:445
- ⧉public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:453
- ⧉public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:461
- ⧉public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:468
- ⧉public __sleep() Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. * * Using the Serialize interface and serialize() / unserialize() methods * breaks entity forms in PHP 5.4. * @todo Investigate in https://www.drupal.org/node/1977206. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:480
- ⧉public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:511
- ⧉public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:524
- ⧉public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:531
- ⧉public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:541
- ⧉public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:548
- ⧉public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:556
- ⧉public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:580
- ⧉public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:587
- ⧉public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:595
- ⧉public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:603
- ⧉public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:616
- ⧉public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:631
- ⧉public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⧉public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⧉public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- ⧉public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:132
- ⧉public isNew() Overrides Entity::isNew().
/** * Overrides Entity::isNew(). * * EntityInterface::enforceIsNew() is only supported for newly created * configuration entities but has no effect after saving, since each * configuration entity is unique. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- ⧉public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:156
- ⧉public set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- ⧉public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- ⧉public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- ⧉public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- ⧉public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- ⧉public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- ⧉public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- ⧉public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- ⧉public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- ⧉public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- ⧉public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- ⧉public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- ⧉public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- ⧉public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- ⧉public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:513
- ⧉public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- ⧉public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- ⧉public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- ⧉public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- ⧉public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- ⧉public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- ⧉public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- ⧉public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- ⧉public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⧉public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⧉public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⧉public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⧉public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- ⧉public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⧉public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⧉public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- ⧉public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- ⧉public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⧉public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⧉public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- ⧉public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- ⧉public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⧉public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⧉public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- ⧉public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⧉public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⧉public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⧉public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⧉public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⧉protected linkTemplates() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:262
- ⧉protected urlRouteParameters($rel) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:278
- ⧉protected addDependencyTrait($type, $name): $this Adds a dependency.
/** * Adds a dependency. * * @param string $type * Type of dependency being added: 'module', 'theme', 'config', 'content'. * @param string $name * If $type is 'module' or 'theme', the name of the module or theme. If * $type is 'config' or 'content', the result of * EntityInterface::getConfigDependencyName(). * * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() * * @return $this */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- ⧉protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/** * Calculates and returns dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. * * @return array * An array of dependencies keyed by the type of dependency. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- ⧉protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * Adds multiple dependencies. * * @param array $dependencies * An array of dependencies keyed by the type of dependency. One example: * @code * [ * 'module' => [ * 'node', * 'field', * 'image', * ], * ]; * @endcode * * @see \Drupal\Core\Entity\DependencyTrait::addDependency */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- ⧉protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/** * Calculates and adds dependencies of a specific plugin instance. * * Dependencies are added for the module that provides the plugin, as well * as any dependencies declared by the instance's calculateDependencies() * method, if it implements * \Drupal\Component\Plugin\DependentPluginInterface. * * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance * The plugin instance. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
- ⧉protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/** * Wraps the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
- ⧉protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/** * Wraps the theme handler. * * @return \Drupal\Core\Extension\ThemeHandlerInterface * The theme handler. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- ⧉protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/** * Gets the typed config manager. * * @return \Drupal\Core\Config\TypedConfigManagerInterface */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- ⧉protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). * * Note that this function should only be called from implementations of * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(), * as dependencies are recalculated during every entity save. * * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency() */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- ⧉protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the entity's cache tag; the config system * already invalidates it. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}\Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields)
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:209
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}\Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields)
/** * {@inheritdoc} */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:235
- ⇄⧉public static loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.\Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name)
/** * 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. */ Defined in <ROOT>/core/modules/field/src/Entity/FieldConfig.php:377
- ⇄⧉public static createFromItemType($item_type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:493
- ⇄⧉public static createFromDataType($type) {@inheritdoc}\Drupal\Core\Field\FieldConfigBase::createFromDataType($type)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:502
- ⇄⧉public static sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Helper callback for uasort() to sort configuration entities by weight and label.\Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b)
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\EntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- ⧉protected static normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/** * Ensure a field value is transformed into a format keyed by delta. * * @param mixed $value * The raw field value to normalize. * @param string $main_property_name * The main field property name. * * @return array * A field value normalized into a format keyed by delta. */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@inheritdoc} * * Override to never invalidate the individual entities' cache tags; the * config system already invalidates them. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- ⧉protected static getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- ⧉protected languages -> array (4)
- ⧉fr => Drupal\Core\Language\Language#1987 (5)
- Properties (5)
- Available methods (9)
- Static class properties (16)
- protected name -> UTF-8 string (9) "Français"
- protected id -> string (2) "fr"
- protected direction -> string (3) "ltr"
- protected weight -> integer 0
- protected locked -> boolean false
- ⧉public __construct(array $values = array()) Constructs a new class instance.
/** * Constructs a new class instance. * * @param array $values * An array of property values, keyed by property name, used to construct * the language. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
- ⧉public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
- ⧉public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
- ⧉public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
- ⧉public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
- ⧉public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
- ⇄⧉public static sort(&$languages) Sort language objects.\Drupal\Core\Language\Language::sort(&$languages)
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
- ⧉protected static getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
- ⇄⧉public static $defaultValues :: array (5)\Drupal\Core\Language\Language::$defaultValues
- ⇄id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- ⇄name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- ⇄direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- ⇄weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- ⇄locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- ⇄id => string (2) "en"
- ⇄public const LANGCODE_SYSTEM :: string (6) "system"\Drupal\Core\Language\Language::LANGCODE_SYSTEM
- ⇄public const LANGCODE_NOT_SPECIFIED :: string (3) "und"\Drupal\Core\Language\Language::LANGCODE_NOT_SPECIFIED
- ⇄public const LANGCODE_NOT_APPLICABLE :: string (3) "zxx"\Drupal\Core\Language\Language::LANGCODE_NOT_APPLICABLE
- ⇄public const LANGCODE_DEFAULT :: string (9) "x-default"\Drupal\Core\Language\Language::LANGCODE_DEFAULT
- ⇄public const LANGCODE_SITE_DEFAULT :: string (12) "site_default"\Drupal\Core\Language\Language::LANGCODE_SITE_DEFAULT
- ⇄public const VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"\Drupal\Core\Language\Language::VALID_LANGCODE_REGEX
- ⇄public const STATE_CONFIGURABLE :: integer 1\Drupal\Core\Language\Language::STATE_CONFIGURABLE
- ⇄public const STATE_LOCKED :: integer 2\Drupal\Core\Language\Language::STATE_LOCKED
- ⇄public const STATE_ALL :: integer 3\Drupal\Core\Language\Language::STATE_ALL
- ⇄public const STATE_SITE_DEFAULT :: integer 4\Drupal\Core\Language\Language::STATE_SITE_DEFAULT
- ⇄public const TYPE_CONTENT :: string (16) "language_content"\Drupal\Core\Language\Language::TYPE_CONTENT
- ⇄public const TYPE_INTERFACE :: string (18) "language_interface"\Drupal\Core\Language\Language::TYPE_INTERFACE
- ⇄public const TYPE_URL :: string (12) "language_url"\Drupal\Core\Language\Language::TYPE_URL
- ⇄public const DIRECTION_LTR :: string (3) "ltr"\Drupal\Core\Language\Language::DIRECTION_LTR
- ⇄public const DIRECTION_RTL :: string (3) "rtl"\Drupal\Core\Language\Language::DIRECTION_RTL
- ⇄⧉public static $defaultValues :: array (5)
- ⧉en => Drupal\Core\Language\Language#1986 (5)
- Properties (5)
- Available methods (9)
- Static class properties (16)
- protected name -> string (7) "English"
- protected id -> string (2) "en"
- protected direction -> string (3) "ltr"
- protected weight -> integer 1
- protected locked -> boolean false
- ⧉public __construct(array $values = array()) Constructs a new class instance.
/** * Constructs a new class instance. * * @param array $values * An array of property values, keyed by property name, used to construct * the language. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
- ⧉public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
- ⧉public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
- ⧉public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
- ⧉public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
- ⧉public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
- ⇄⧉public static sort(&$languages) Sort language objects.\Drupal\Core\Language\Language::sort(&$languages)
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
- ⧉protected static getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
- ⇄⧉public static $defaultValues :: array (5)\Drupal\Core\Language\Language::$defaultValues
- ⇄id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- ⇄name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- ⇄direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- ⇄weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- ⇄locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- ⇄id => string (2) "en"
- ⇄public const LANGCODE_SYSTEM :: string (6) "system"\Drupal\Core\Language\Language::LANGCODE_SYSTEM
- ⇄public const LANGCODE_NOT_SPECIFIED :: string (3) "und"\Drupal\Core\Language\Language::LANGCODE_NOT_SPECIFIED
- ⇄public const LANGCODE_NOT_APPLICABLE :: string (3) "zxx"\Drupal\Core\Language\Language::LANGCODE_NOT_APPLICABLE
- ⇄public const LANGCODE_DEFAULT :: string (9) "x-default"\Drupal\Core\Language\Language::LANGCODE_DEFAULT
- ⇄public const LANGCODE_SITE_DEFAULT :: string (12) "site_default"\Drupal\Core\Language\Language::LANGCODE_SITE_DEFAULT
- ⇄public const VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"\Drupal\Core\Language\Language::VALID_LANGCODE_REGEX
- ⇄public const STATE_CONFIGURABLE :: integer 1\Drupal\Core\Language\Language::STATE_CONFIGURABLE
- ⇄public const STATE_LOCKED :: integer 2\Drupal\Core\Language\Language::STATE_LOCKED
- ⇄public const STATE_ALL :: integer 3\Drupal\Core\Language\Language::STATE_ALL
- ⇄public const STATE_SITE_DEFAULT :: integer 4\Drupal\Core\Language\Language::STATE_SITE_DEFAULT
- ⇄public const TYPE_CONTENT :: string (16) "language_content"\Drupal\Core\Language\Language::TYPE_CONTENT
- ⇄public const TYPE_INTERFACE :: string (18) "language_interface"\Drupal\Core\Language\Language::TYPE_INTERFACE
- ⇄public const TYPE_URL :: string (12) "language_url"\Drupal\Core\Language\Language::TYPE_URL
- ⇄public const DIRECTION_LTR :: string (3) "ltr"\Drupal\Core\Language\Language::DIRECTION_LTR
- ⇄public const DIRECTION_RTL :: string (3) "rtl"\Drupal\Core\Language\Language::DIRECTION_RTL
- ⇄⧉public static $defaultValues :: array (5)
- ⧉und => Drupal\Core\Language\Language#1988 (5)
- Properties (5)
- Available methods (9)
- Static class properties (16)
- protected name -> UTF-8 string (14) "Non spécifié"
- protected id -> string (3) "und"
- protected direction -> string (3) "ltr"
- protected weight -> integer 2
- protected locked -> boolean true
- ⧉public __construct(array $values = array()) Constructs a new class instance.
/** * Constructs a new class instance. * * @param array $values * An array of property values, keyed by property name, used to construct * the language. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
- ⧉public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
- ⧉public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
- ⧉public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
- ⧉public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
- ⧉public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
- ⇄⧉public static sort(&$languages) Sort language objects.\Drupal\Core\Language\Language::sort(&$languages)
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
- ⧉protected static getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
- ⇄⧉public static $defaultValues :: array (5)\Drupal\Core\Language\Language::$defaultValues
- ⇄id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- ⇄name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- ⇄direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- ⇄weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- ⇄locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- ⇄id => string (2) "en"
- ⇄public const LANGCODE_SYSTEM :: string (6) "system"\Drupal\Core\Language\Language::LANGCODE_SYSTEM
- ⇄public const LANGCODE_NOT_SPECIFIED :: string (3) "und"\Drupal\Core\Language\Language::LANGCODE_NOT_SPECIFIED
- ⇄public const LANGCODE_NOT_APPLICABLE :: string (3) "zxx"\Drupal\Core\Language\Language::LANGCODE_NOT_APPLICABLE
- ⇄public const LANGCODE_DEFAULT :: string (9) "x-default"\Drupal\Core\Language\Language::LANGCODE_DEFAULT
- ⇄public const LANGCODE_SITE_DEFAULT :: string (12) "site_default"\Drupal\Core\Language\Language::LANGCODE_SITE_DEFAULT
- ⇄public const VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"\Drupal\Core\Language\Language::VALID_LANGCODE_REGEX
- ⇄public const STATE_CONFIGURABLE :: integer 1\Drupal\Core\Language\Language::STATE_CONFIGURABLE
- ⇄public const STATE_LOCKED :: integer 2\Drupal\Core\Language\Language::STATE_LOCKED
- ⇄public const STATE_ALL :: integer 3\Drupal\Core\Language\Language::STATE_ALL
- ⇄public const STATE_SITE_DEFAULT :: integer 4\Drupal\Core\Language\Language::STATE_SITE_DEFAULT
- ⇄public const TYPE_CONTENT :: string (16) "language_content"\Drupal\Core\Language\Language::TYPE_CONTENT
- ⇄public const TYPE_INTERFACE :: string (18) "language_interface"\Drupal\Core\Language\Language::TYPE_INTERFACE
- ⇄public const TYPE_URL :: string (12) "language_url"\Drupal\Core\Language\Language::TYPE_URL
- ⇄public const DIRECTION_LTR :: string (3) "ltr"\Drupal\Core\Language\Language::DIRECTION_LTR
- ⇄public const DIRECTION_RTL :: string (3) "rtl"\Drupal\Core\Language\Language::DIRECTION_RTL
- ⇄⧉public static $defaultValues :: array (5)
- ⧉zxx => Drupal\Core\Language\Language#1823 (5)
- Properties (5)
- Available methods (9)
- Static class properties (16)
- protected name -> string (14) "Non applicable"
- protected id -> string (3) "zxx"
- protected direction -> string (3) "ltr"
- protected weight -> integer 3
- protected locked -> boolean true
- ⧉public __construct(array $values = array()) Constructs a new class instance.
/** * Constructs a new class instance. * * @param array $values * An array of property values, keyed by property name, used to construct * the language. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:77
- ⧉public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:101
- ⧉public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:108
- ⧉public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:115
- ⧉public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:122
- ⧉public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:129
- ⧉public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:136
- ⇄⧉public static sort(&$languages) Sort language objects.\Drupal\Core\Language\Language::sort(&$languages)
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:146
- ⧉protected static getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <ROOT>/core/lib/Drupal/Core/Language/Language.php:173
- ⇄⧉public static $defaultValues :: array (5)\Drupal\Core\Language\Language::$defaultValues
- ⇄id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- ⇄name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- ⇄direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- ⇄weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- ⇄locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- ⇄id => string (2) "en"
- ⇄public const LANGCODE_SYSTEM :: string (6) "system"\Drupal\Core\Language\Language::LANGCODE_SYSTEM
- ⇄public const LANGCODE_NOT_SPECIFIED :: string (3) "und"\Drupal\Core\Language\Language::LANGCODE_NOT_SPECIFIED
- ⇄public const LANGCODE_NOT_APPLICABLE :: string (3) "zxx"\Drupal\Core\Language\Language::LANGCODE_NOT_APPLICABLE
- ⇄public const LANGCODE_DEFAULT :: string (9) "x-default"\Drupal\Core\Language\Language::LANGCODE_DEFAULT
- ⇄public const LANGCODE_SITE_DEFAULT :: string (12) "site_default"\Drupal\Core\Language\Language::LANGCODE_SITE_DEFAULT
- ⇄public const VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"\Drupal\Core\Language\Language::VALID_LANGCODE_REGEX
- ⇄public const STATE_CONFIGURABLE :: integer 1\Drupal\Core\Language\Language::STATE_CONFIGURABLE
- ⇄public const STATE_LOCKED :: integer 2\Drupal\Core\Language\Language::STATE_LOCKED
- ⇄public const STATE_ALL :: integer 3\Drupal\Core\Language\Language::STATE_ALL
- ⇄public const STATE_SITE_DEFAULT :: integer 4\Drupal\Core\Language\Language::STATE_SITE_DEFAULT
- ⇄public const TYPE_CONTENT :: string (16) "language_content"\Drupal\Core\Language\Language::TYPE_CONTENT
- ⇄public const TYPE_INTERFACE :: string (18) "language_interface"\Drupal\Core\Language\Language::TYPE_INTERFACE
- ⇄public const TYPE_URL :: string (12) "language_url"\Drupal\Core\Language\Language::TYPE_URL
- ⇄public const DIRECTION_LTR :: string (3) "ltr"\Drupal\Core\Language\Language::DIRECTION_LTR
- ⇄public const DIRECTION_RTL :: string (3) "rtl"\Drupal\Core\Language\Language::DIRECTION_RTL
- ⇄⧉public static $defaultValues :: array (5)
- protected langcodeKey -> string (8) "langcode"
- protected defaultLangcodeKey -> string (16) "default_langcode"
- protected activeLangcode -> string (9) "x-default"
- protected enforceDefaultTranslation -> null
- protected defaultLangcode -> string (2) "fr"
- ⧉protected translations -> array (1)
- ⧉x-default => array (2)
- status => integer 1
- ⧉entity => Drupal\custom_landing\Entity\Node#1822 (30) Recursion
- protected translationInitialize -> boolean false
- protected newRevision -> boolean false
- protected isDefaultRevision -> string (1) "1"
- ⧉protected entityKeys -> array (4)
- bundle => string (13) "home_minisite"
- id => string (2) "79"
- revision => string (4) "3376"
- uuid => string (36) "4bf51466-1519-40bd-ba2f-b1c024d57a87"
- ⧉protected translatableEntityKeys -> array (8)
- ⧉label => array (1)
- x-default => string (29) "[DER Biologie] Page d'accueil"
- ⧉langcode => array (1)
- x-default => string (2) "fr"
- ⧉status => array (1)
- x-default => string (1) "1"
- ⧉published => array (1)
- x-default => string (1) "1"
- ⧉uid => array (1)
- x-default => string (1) "1"
- ⧉owner => array (1)
- x-default => string (1) "1"
- ⧉default_langcode => array (1)
- x-default => string (1) "1"
- ⧉revision_translation_affected => array (1)
- x-default => null
- protected validated -> boolean false
- protected validationRequired -> boolean false
- protected loadedRevisionId -> string (4) "3376"
- protected revisionTranslationAffectedKey -> string (29) "revision_translation_affected"
- protected enforceRevisionTranslationAffected -> array (0)
- protected isSyncing -> boolean false
- ⇄public in_preview -> null$0->in_preview
- ⇄⧉public toUrl($rel = 'canonical', array $options = array()) Overriden for landing nodes field_url$0->toUrl($rel = 'canonical', array $options = array())
/** * Overriden for landing nodes * field_url */ Defined in <ROOT>/modules/intuitiv/custom_landing/src/Entity/Node.php:15
- ⇄⧉public getOwnerId() {@inheritdoc}$0->getOwnerId()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:48
- ⇄⧉public setOwnerId($uid) {@inheritdoc}$0->setOwnerId($uid)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:55
- ⇄⧉public getOwner() {@inheritdoc}$0->getOwner()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:65
- ⇄⧉public setOwner(Drupal\user\UserInterface $account) {@inheritdoc}$0->setOwner(Drupal\user\UserInterface $account)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:73
- ⇄⧉public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}$0->preSave(Drupal\Core\Entity\EntityStorageInterface $storage)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:104
- ⇄⧉public preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record) {@inheritdoc}$0->preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:126
- ⇄⧉public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}$0->postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:141
- ⇄⧉public getType() {@inheritdoc}$0->getType()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:197
- ⇄⧉public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:204
- ⇄⧉public getTitle() {@inheritdoc}$0->getTitle()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:212
- ⇄⧉public setTitle($title) {@inheritdoc}$0->setTitle($title)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:219
- ⇄⧉public getCreatedTime() {@inheritdoc}$0->getCreatedTime()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:227
- ⇄⧉public setCreatedTime($timestamp) {@inheritdoc}$0->setCreatedTime($timestamp)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:234
- ⇄⧉public isPromoted() {@inheritdoc}$0->isPromoted()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:242
- ⇄⧉public setPromoted($promoted) {@inheritdoc}$0->setPromoted($promoted)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:249
- ⇄⧉public isSticky() {@inheritdoc}$0->isSticky()
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:257
- ⇄⧉public setSticky($sticky) {@inheritdoc}$0->setSticky($sticky)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:264
- ⇄⧉public getChangedTimeAcrossTranslations(): int Returns the timestamp of the last entity change across all translations.$0->getChangedTimeAcrossTranslations()
/** * Returns the timestamp of the last entity change across all translations. * * @return int * The timestamp of the last entity save operation across all * translations. */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:17
- ⇄⧉public getChangedTime(): int|null Gets the timestamp of the last entity change for the current translation.$0->getChangedTime()
/** * Gets the timestamp of the last entity change for the current translation. * * @return int|null * The timestamp of the last entity save operation. Some entities allow a * NULL value indicating the changed time is unknown. */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:33
- ⇄⧉public setChangedTime($timestamp): $this Sets the timestamp of the last entity change for the current translation.$0->setChangedTime($timestamp)
/** * Sets the timestamp of the last entity change for the current translation. * * @param int $timestamp * The timestamp of the last entity save operation. * * @return $this */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46
- ⇄⧉public isPublished() {@inheritdoc}$0->isPublished()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:47
- ⇄⧉public setPublished() {@inheritdoc}$0->setPublished()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:54
- ⇄⧉public setUnpublished() {@inheritdoc}$0->setUnpublished()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:64
- ⇄⧉public getRevisionCreationTime() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().$0->getRevisionCreationTime()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:69
- ⇄⧉public setRevisionCreationTime($timestamp) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().$0->setRevisionCreationTime($timestamp)
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:76
- ⇄⧉public getRevisionUser() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().$0->getRevisionUser()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:84
- ⇄⧉public setRevisionUser(Drupal\user\UserInterface $account) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().$0->setRevisionUser(Drupal\user\UserInterface $account)
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:91
- ⇄⧉public getRevisionUserId() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().$0->getRevisionUserId()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:99
- ⇄⧉public setRevisionUserId($user_id) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().$0->setRevisionUserId($user_id)
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:106
- ⇄⧉public getRevisionLogMessage() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().$0->getRevisionLogMessage()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:114
- ⇄⧉public setRevisionLogMessage($revision_log_message) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().$0->setRevisionLogMessage($revision_log_message)
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:121
- ⇄⧉public setSyncing($syncing) {@inheritdoc}$0->setSyncing($syncing)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- ⇄⧉public isSyncing() {@inheritdoc}$0->isSyncing()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- ⇄⧉public __construct(array $values, $entity_type, $bundle = false, $translations = array()) {@inheritdoc}new \Drupal\custom_landing\Entity\Node(array $values, $entity_type, $bundle = false, $translations = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:201
- ⇄⧉public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}$0->postCreate(Drupal\Core\Entity\EntityStorageInterface $storage)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:296
- ⇄⧉public setNewRevision($value = true) {@inheritdoc}$0->setNewRevision($value = true)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:303
- ⇄⧉public getLoadedRevisionId() {@inheritdoc}$0->getLoadedRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:325
- ⇄⧉public updateLoadedRevisionId() {@inheritdoc}$0->updateLoadedRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:332
- ⇄⧉public isNewRevision() {@inheritdoc}$0->isNewRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:340
- ⇄⧉public isDefaultRevision($new_value = null) {@inheritdoc}$0->isDefaultRevision($new_value = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:347
- ⇄⧉public wasDefaultRevision() {@inheritdoc}$0->wasDefaultRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:360
- ⇄⧉public isLatestRevision() {@inheritdoc}$0->isLatestRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:375
- ⇄⧉public isLatestTranslationAffectedRevision() {@inheritdoc}$0->isLatestTranslationAffectedRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:385
- ⇄⧉public isRevisionTranslationAffected() {@inheritdoc}$0->isRevisionTranslationAffected()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:395
- ⇄⧉public setRevisionTranslationAffected($affected) {@inheritdoc}$0->setRevisionTranslationAffected($affected)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:402
- ⇄⧉public isRevisionTranslationAffectedEnforced() {@inheritdoc}$0->isRevisionTranslationAffectedEnforced()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:412
- ⇄⧉public setRevisionTranslationAffectedEnforced($enforced) {@inheritdoc}$0->setRevisionTranslationAffectedEnforced($enforced)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:419
- ⇄⧉public setDefaultTranslationEnforced(?bool $enforce_default_translation): static Set or clear an override of the isDefaultTranslation() result.$0->setDefaultTranslationEnforced(?bool $enforce_default_translation)
/** * Set or clear an override of the isDefaultTranslation() result. * * @param bool|null $enforce_default_translation * If boolean value is passed, the value will override the result of * isDefaultTranslation() method. If NULL is passed, the default logic will * be used. * * @return $this */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:434
- ⇄⧉public isDefaultTranslation() {@inheritdoc}$0->isDefaultTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:442
- ⇄⧉public getRevisionId() {@inheritdoc}$0->getRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:452
- ⇄⧉public isTranslatable() {@inheritdoc}$0->isTranslatable()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:459
- ⇄⧉public validate() {@inheritdoc}$0->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:516
- ⇄⧉public isValidationRequired() {@inheritdoc}$0->isValidationRequired()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:525
- ⇄⧉public setValidationRequired($required) {@inheritdoc}$0->setValidationRequired($required)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:532
- ⧉public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:549
- ⇄⧉public id() {@inheritdoc}$0->id()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:567
- ⇄⧉public bundle() {@inheritdoc}$0->bundle()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:574
- ⇄⧉public uuid() {@inheritdoc}$0->uuid()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:581
- ⇄⧉public hasField($field_name) {@inheritdoc}$0->hasField($field_name)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:588
- ⇄⧉public get($field_name) {@inheritdoc}$0->get($field_name)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:595
- ⇄⧉public set($name, $value, $notify = true) {@inheritdoc}$0->set($name, $value, $notify = true)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:653
- ⇄⧉public getFields($include_computed = true) {@inheritdoc}$0->getFields($include_computed = true)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:664
- ⇄⧉public getTranslatableFields($include_computed = true) {@inheritdoc}$0->getTranslatableFields($include_computed = true)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:677
- ⇄⧉public getIterator() {@inheritdoc}$0->getIterator()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:691
- ⇄⧉public getFieldDefinition($name) {@inheritdoc}$0->getFieldDefinition($name)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:698
- ⇄⧉public getFieldDefinitions() {@inheritdoc}$0->getFieldDefinitions()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:710
- ⇄⧉public toArray() {@inheritdoc}$0->toArray()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:720
- ⇄⧉public language() {@inheritdoc}$0->language()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:745
- ⇄⧉public onChange($name) {@inheritdoc}$0->onChange($name)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:811
- ⇄⧉public getTranslation($langcode) {@inheritdoc}$0->getTranslation($langcode)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:877
- ⇄⧉public getUntranslated() {@inheritdoc}$0->getUntranslated()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:912
- ⇄⧉public hasTranslation($langcode) {@inheritdoc}$0->hasTranslation($langcode)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:963
- ⇄⧉public isNewTranslation() {@inheritdoc}$0->isNewTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:973
- ⇄⧉public addTranslation($langcode, array $values = array()) {@inheritdoc}$0->addTranslation($langcode, array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:980
- ⇄⧉public removeTranslation($langcode) {@inheritdoc}$0->removeTranslation($langcode)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1001
- ⇄⧉public getTranslationStatus($langcode) {@inheritdoc}$0->getTranslationStatus($langcode)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1030
- ⇄⧉public getTranslationLanguages($include_default = true) {@inheritdoc}$0->getTranslationLanguages($include_default = true)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1040
- ⇄⧉public updateOriginalValues() Updates the original values with the interim changes.$0->updateOriginalValues()
/** * Updates the original values with the interim changes. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1057
- ⧉public & __get($name) Implements the magic method for getting object properties.
/** * Implements the magic method for getting object properties. * * @todo A lot of code still uses non-fields (e.g. $entity->content in view * builders) by reference. Clean that up. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1077
- ⧉public __set($name, $value) Implements the magic method for setting object properties.
/** * Implements the magic method for setting object properties. * * Uses default language always. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1104
- ⧉public __isset($name) Implements the magic method for isset().
/** * Implements the magic method for isset(). */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1138
- ⧉public __unset($name) Implements the magic method for unset().
/** * Implements the magic method for unset(). */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1147
- ⇄⧉public createDuplicate() {@inheritdoc}$0->createDuplicate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1178
- ⇄⧉public __clone() Magic method: Implements a deep clone.clone $0
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1211
- ⇄⧉public label() {@inheritdoc}$0->label()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1297
- ⇄⧉public referencedEntities() {@inheritdoc}$0->referencedEntities()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1306
- ⇄⧉public hasTranslationChanges() {@inheritdoc}$0->hasTranslationChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1446
- ⇄⧉public isDefaultTranslationAffectedOnly() {@inheritdoc}$0->isDefaultTranslationAffectedOnly()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1505
- ⇄⧉public addCacheableDependency($other_object) {@inheritdoc}$0->addCacheableDependency($other_object)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- ⇄⧉public addCacheContexts(array $cache_contexts) {@inheritdoc}$0->addCacheContexts(array $cache_contexts)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- ⇄⧉public traitSleep() {@inheritdoc}$0->traitSleep()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- ⇄⧉public addCacheTags(array $cache_tags) {@inheritdoc}$0->addCacheTags(array $cache_tags)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- ⇄⧉public mergeCacheMaxAge($max_age) {@inheritdoc}$0->mergeCacheMaxAge($max_age)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- ⧉public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- ⇄⧉public isNew() {@inheritdoc}$0->isNew()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:120
- ⇄⧉public enforceIsNew($value = true) {@inheritdoc}$0->enforceIsNew($value = true)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- ⇄⧉public getEntityTypeId() {@inheritdoc}$0->getEntityTypeId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- ⇄⧉public hasLinkTemplate($rel) {@inheritdoc}$0->hasLinkTemplate($rel)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- ⇄⧉public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}$0->toLink($text = null, $rel = 'canonical', array $options = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- ⇄⧉public uriRelationships() {@inheritdoc}$0->uriRelationships()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- ⇄⧉public save() {@inheritdoc}$0->save()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:352
- ⇄⧉public delete() {@inheritdoc}$0->delete()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- ⇄⧉public getEntityType() {@inheritdoc}$0->getEntityType()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- ⇄⧉public getCacheContexts() {@inheritdoc}$0->getCacheContexts()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- ⇄⧉public getCacheTagsToInvalidate() {@inheritdoc}$0->getCacheTagsToInvalidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:472
- ⇄⧉public getCacheTags() {@inheritdoc}$0->getCacheTags()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- ⇄⧉public getCacheMaxAge() {@inheritdoc}$0->getCacheMaxAge()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- ⇄⧉public getOriginalId() {@inheritdoc}$0->getOriginalId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:574
- ⇄⧉public setOriginalId($id) {@inheritdoc}$0->setOriginalId($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:582
- ⇄⧉public getTypedData() {@inheritdoc}$0->getTypedData()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- ⇄⧉public getConfigDependencyKey() {@inheritdoc}$0->getConfigDependencyKey()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- ⇄⧉public getConfigDependencyName() {@inheritdoc}$0->getConfigDependencyName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:655
- ⇄⧉public getConfigTarget() {@inheritdoc}$0->getConfigTarget()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:662
- ⧉protected traitGetFieldsToSkipFromTranslationChangesCheck(Drupal\Core\Entity\ContentEntityInterface $entity): string[] Returns an array of field names to skip when checking for changes.
/** * Returns an array of field names to skip when checking for changes. * * @param \Drupal\Core\Entity\ContentEntityInterface $entity * A content entity object. * * @return string[] * An array of field names. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityChangesDetectionTrait.php:21
- ⧉protected getLanguages() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:280
- ⧉protected clearTranslationCache() Clears entity translation object cache to remove stale references.
/** * Clears entity translation object cache to remove stale references. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:540
- ⧉protected getTranslatedField($name, $langcode): \Drupal\Core\Field\FieldItemListInterface Gets a translated field.
/** * Gets a translated field. * * @return \Drupal\Core\Field\FieldItemListInterface */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:607
- ⧉protected setDefaultLangcode() Populates the local cache for the default language code.
/** * Populates the local cache for the default language code. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:767
- ⧉protected updateFieldLangcodes($langcode) Updates language for already instantiated fields.
/** * Updates language for already instantiated fields. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:800
- ⧉protected initializeTranslation($langcode): \Drupal\Core\Entity\EntityInterface Instantiates a translation object for an existing translation.
/** * Instantiates a translation object for an existing translation. * * The translated entity will be a clone of the current entity with the * specified $langcode. All translations share the same field data structures * to ensure that all of them deal with fresh data. * * @param string $langcode * The language code for the requested translation. * * @return \Drupal\Core\Entity\EntityInterface * The translation object. The content properties of the translation object * are stored as references to the main entity. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:930
- ⧉protected getEntityKey($key): mixed Gets the value of the given entity key, if defined.
/** * Gets the value of the given entity key, if defined. * * @param string $key * Name of the entity key, for example id, revision or bundle. * * @return mixed * The value of the entity key, NULL if not defined. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1333
- ⧉protected getFieldsToSkipFromTranslationChangesCheck(): array Returns an array of field names to skip in ::hasTranslationChanges.
/** * Returns an array of field names to skip in ::hasTranslationChanges. * * @return array * An array of field names. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1435
- ⧉protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/** * Sets cacheability; useful for value object constructors. * * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability * The cacheability to set. * * @return $this */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- ⧉protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/** * Gets the entity type manager. * * @return \Drupal\Core\Entity\EntityTypeManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:72
- ⧉protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/** * Gets the entity type bundle info service. * * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:81
- ⧉protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/** * Gets the language manager. * * @return \Drupal\Core\Language\LanguageManagerInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:90
- ⧉protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/** * Gets the UUID generator. * * @return \Drupal\Component\Uuid\UuidInterface */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- ⧉protected linkTemplates(): array Gets an array link templates.
/** * Gets an array link templates. * * @return array * An array of link templates containing paths. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- ⧉protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/** * Gets an array of placeholders for this entity. * * Individual entity classes may override this method to add additional * placeholders if desired. If so, they should be sure to replicate the * property caching logic. * * @param string $rel * The link relationship type, for example: canonical or edit-form. * * @return array * An array of URI placeholders. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- ⧉protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/** * The list cache tags to invalidate for this entity. * * @return string[] * Set of list cache tags. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- ⧉protected invalidateTagsOnSave($update) Invalidates an entity's cache tags upon save.
/** * Invalidates an entity's cache tags upon save. * * @param bool $update * TRUE if the entity has been updated, or FALSE if it has been inserted. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:532
- ⇄⧉public static ownerBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for entity owners.\Drupal\node\Entity\Node::ownerBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type)
/** * Returns an array of base field definitions for entity owners. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type to add the owner field to. * * @return \Drupal\Core\Field\BaseFieldDefinition[] * An array of base field definitions. * * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException * Thrown when the entity type does not implement EntityOwnerInterface or * if it does not have an "owner" entity key. */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:28
- ⇄⧉public static getDefaultEntityOwner(): mixed Default value callback for 'owner' base field.\Drupal\node\Entity\Node::getDefaultEntityOwner()
/** * Default value callback for 'owner' base field. * * @return mixed * A default value for the owner field. */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/user/src/EntityOwnerTrait.php:86
- ⇄⧉public static preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}\Drupal\node\Entity\Node::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:173
- ⇄⧉public static postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $nodes) {@inheritdoc}\Drupal\node\Entity\Node::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $nodes)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:189
- ⇄⧉public static baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}\Drupal\node\Entity\Node::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type)
/** * {@inheritdoc} */ Inherited from Drupal\node\Entity\Node Defined in <ROOT>/core/modules/node/src/Entity/Node.php:272
- ⇄⧉public static publishedBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for publishing status.\Drupal\Core\Entity\EditorialContentEntityBase::publishedBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type)
/** * Returns an array of base field definitions for publishing status. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type to add the publishing status field to. * * @return \Drupal\Core\Field\BaseFieldDefinition[] * An array of base field definitions. * * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException * Thrown when the entity type does not implement EntityPublishedInterface * or if it does not have a "published" entity key. */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:27
- ⇄⧉public static revisionLogBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\FieldDefinitionInterface[] Provides revision-related base field definitions for an entity type.\Drupal\Core\Entity\EditorialContentEntityBase::revisionLogBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type)
/** * Provides revision-related base field definitions for an entity type. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type definition. * * @return \Drupal\Core\Field\FieldDefinitionInterface[] * An array of base field definitions for the entity type, keyed by field * name. * * @see \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions() */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:28
- ⇄⧉public static create(array $values = array()) {@inheritdoc}\Drupal\Core\Entity\ContentEntityBase::create(array $values = array())
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1161
- ⇄⧉public static bundleFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {@inheritdoc}\Drupal\Core\Entity\ContentEntityBase::bundleFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1425
- ⇄⧉public static preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}\Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- ⇄⧉public static postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}\Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- ⇄⧉public static load($id) {@inheritdoc}\Drupal\Core\Entity\EntityBase::load($id)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- ⇄⧉public static loadMultiple(?array $ids = null) {@inheritdoc}\Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null)
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- ⧉protected static invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/** * Invalidates an entity's cache tags upon delete. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type definition. * @param \Drupal\Core\Entity\EntityInterface[] $entities * An array of entities. */ Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- ⇄⧉public toUrl($rel = 'canonical', array $options = array()) Overriden for landing nodes field_url
- protected static $fieldsToSkipFromTranslationChangesCheck :: array (0)
- ⇄public const TRANSLATION_REMOVED :: integer 0\Drupal\custom_landing\Entity\Node::TRANSLATION_REMOVED
- ⇄public const TRANSLATION_EXISTING :: integer 1\Drupal\custom_landing\Entity\Node::TRANSLATION_EXISTING
- ⇄public const TRANSLATION_CREATED :: integer 2\Drupal\custom_landing\Entity\Node::TRANSLATION_CREATED
- ⇄public const NOT_PUBLISHED :: integer 0\Drupal\custom_landing\Entity\Node::NOT_PUBLISHED
- ⇄public const PUBLISHED :: integer 1\Drupal\custom_landing\Entity\Node::PUBLISHED
- ⇄public const NOT_PROMOTED :: integer 0\Drupal\custom_landing\Entity\Node::NOT_PROMOTED
- ⇄public const PROMOTED :: integer 1\Drupal\custom_landing\Entity\Node::PROMOTED
- ⇄public const NOT_STICKY :: integer 0\Drupal\custom_landing\Entity\Node::NOT_STICKY
- ⇄public const STICKY :: integer 1\Drupal\custom_landing\Entity\Node::STICKY