- $0 array (6)
- #user => Drupal\user\Entity\User#1282 (29)$0['#user']
- Entity Fields (24)
- Properties (29)
- Methods (139)
- Static methods (16)
- Static properties (2)
- Class constants (12)
- Iterator
- uid -> string (4) "6398"$0['#user']->uid->value
- uuid -> string (36) "8e7b6131-4367-4c70-a3f9-42d9265546ff"$0['#user']->uuid->value
- langcode -> string (2) "en"$0['#user']->langcode->value
- preferred_langcode -> string (2) "en"$0['#user']->preferred_langcode->value
- preferred_admin_langcode -> string (2) "en"$0['#user']->preferred_admin_langcode->value
- name -> string (12) "Phyllis Chan"$0['#user']->name->value
- pass -> string (55) "$S$Dv/B94eP3SUiNTMMexQ5BhmiiB/Rn2h5sbH6VrWUd0AP5P/CX/yN"$0['#user']->pass->value
- mail -> string (27) "pchan@horizoncounselling.ca"$0['#user']->mail->value
- timezone -> string (17) "America/Vancouver"$0['#user']->timezone->value
- status -> string (1) "1"$0['#user']->status->value
- created -> string (10) "1611609074"$0['#user']->created->value
2021-01-25T21:11:14+00:00
- changed -> string (10) "1752188199"$0['#user']->changed->value
2025-07-10T22:56:39+00:00
- access -> string (10) "1750272695"$0['#user']->access->value
2025-06-18T18:51:35+00:00
- login -> string (10) "1750272059"$0['#user']->login->value
2025-06-18T18:40:59+00:00
- init -> string (27) "pchan@horizoncounselling.ca"$0['#user']->init->value
- roles -> string (14) "premium_member"$0['#user']->roles->target_id
- default_langcode -> string (1) "1"$0['#user']->default_langcode->value
- metatag -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#5624 (11)$0['#user']->metatag
- Field (3)
- Properties (11)
- Methods (71)
- Static methods (2)
- Iterator
- 0 => array (2)$0['#user']->metatag->getValue()[0]
- tag => string (4) "meta"$0['#user']->metatag->getValue()[0]['tag']
- ⇄attributes => array (2) Depth Limit$0['#user']->metatag->getValue()[0]['attributes']
- tag => string (4) "meta"
- 1 => array (2)$0['#user']->metatag->getValue()[1]
- tag => string (4) "meta"$0['#user']->metatag->getValue()[1]['tag']
- ⇄attributes => array (2) Depth Limit$0['#user']->metatag->getValue()[1]['attributes']
- tag => string (4) "meta"
- 2 => array (2)$0['#user']->metatag->getValue()[2]
- tag => string (4) "link"$0['#user']->metatag->getValue()[2]['tag']
- ⇄attributes => array (2) Depth Limit$0['#user']->metatag->getValue()[2]['attributes']
- tag => string (4) "link"
- 0 => array (2)
- protected definition -> Drupal\Core\Field\BaseFieldDefinition#1354 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1357 Depth Limit
- protected type -> string (16) "metatag_computed"
- protected propertyDefinitions -> array (2) Depth Limit
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- protected name -> string (7) "metatag"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#1581 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#892 Blacklisted
- protected list -> array (3)
- 0 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#6129 Depth Limit
- 1 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#6136 Depth Limit
- 2 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#6142 Depth Limit
- protected langcode -> string (2) "en"
- protected metatagsGenerated -> boolean true
- protected valueComputed -> boolean true
- protected valueNeedsRecomputing() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:30
- protected computeValue() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:37
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:40
- public getEntity() {@inheritdoc}$0['#user']->metatag->getEntity()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:47
- public setLangcode($langcode) {@inheritdoc}$0['#user']->metatag->setLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:56
- public getLangcode() {@inheritdoc}$0['#user']->metatag->getLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:63
- public getFieldDefinition() {@inheritdoc}$0['#user']->metatag->getFieldDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:70
- public getSettings() {@inheritdoc}$0['#user']->metatag->getSettings()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:77
- public getSetting($setting_name) {@inheritdoc}$0['#user']->metatag->getSetting()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:84
- public filterEmptyItems() {@inheritdoc}$0['#user']->metatag->filterEmptyItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:91
- public setValue($values, $notify = true) {@inheritdoc}$0['#user']->metatag->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:113
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:123
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:133
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:143
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0['#user']->metatag->access()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0['#user']->metatag->defaultAccess()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
- public applyDefaultValue($notify = true) {@inheritdoc}$0['#user']->metatag->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:148
- public preSave() {@inheritdoc}$0['#user']->metatag->preSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
- public postSave($update) {@inheritdoc}$0['#user']->metatag->postSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
- public delete() {@inheritdoc}$0['#user']->metatag->delete()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
- public deleteRevision() {@inheritdoc}$0['#user']->metatag->deleteRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:212
- protected delegateMethod($method): array Calls a method on each FieldItem.
/** * Calls a method on each FieldItem. * * Any argument passed will be forwarded to the invoked method. * * @param string $method * The name of the method to be invoked. * * @return array * An array of results keyed by delta. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
- public view($display_options = array()) {@inheritdoc}$0['#user']->metatag->view()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
- public generateSampleItems($count = 1) {@inheritdoc}$0['#user']->metatag->generateSampleItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
- public getConstraints() {@inheritdoc}$0['#user']->metatag->getConstraints()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->metatag->defaultValuesForm()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
- public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->metatag->defaultValuesFormValidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:300
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->metatag->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:319
- protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/** * Returns the widget object used in default value form. * * @param \Drupal\Core\Form\FormStateInterface $form_state * The form state of the (entire) configuration form. * * @return \Drupal\Core\Field\WidgetInterface|null * A Widget object or NULL if no widget is available. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0['#user']->metatag->equals()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0['#user']->metatag->hasAffectingChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
- public getValue() {@inheritdoc}$0['#user']->metatag->getValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
- public getString() {@inheritdoc}$0['#user']->metatag->getString()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
- public get($index) {@inheritdoc}$0['#user']->metatag->get()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
- public set($index, $value) {@inheritdoc}$0['#user']->metatag->set()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
- public removeItem($index) {@inheritdoc}$0['#user']->metatag->removeItem()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:105
- protected rekey($from_index = 0) Renumbers the items in the list.
/** * Renumbers the items in the list. * * @param int $from_index * Optionally, the index at which to start the renumbering, if it is known * that items before that can safely be skipped (for example, when removing * an item at a given index). */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:154
- public first() {@inheritdoc}$0['#user']->metatag->first()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:167
- public offsetExists($offset) {@inheritdoc}$0['#user']->metatag->offsetExists()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:122
- public offsetUnset($offset) {@inheritdoc}$0['#user']->metatag->offsetUnset()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:184
- public offsetGet($offset) {@inheritdoc}$0['#user']->metatag->offsetGet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:192
- public offsetSet($offset, $value) {@inheritdoc}$0['#user']->metatag->offsetSet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
- public appendItem($value = null) {@inheritdoc}$0['#user']->metatag->appendItem()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
- public getItemDefinition() {@inheritdoc}$0['#user']->metatag->getItemDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:232
- public getIterator() {@inheritdoc}$0['#user']->metatag->getIterator()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:131
- public count() {@inheritdoc}$0['#user']->metatag->count()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:140
- public isEmpty() {@inheritdoc}$0['#user']->metatag->isEmpty()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
- public filter($callback) {@inheritdoc}$0['#user']->metatag->filter()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:273
- public onChange($delta) {@inheritdoc}$0['#user']->metatag->onChange()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:295
- public __clone() Magic method: Implements a deep clone.clone $0['#user']->metatag
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:305
- public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.new \Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList()
/** * Constructs a TypedData object given its definition and context. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * The data definition. * @param string $name * (optional) The name of the created property, or NULL if it is the root * of a typed data tree. Defaults to NULL. * @param \Drupal\Core\TypedData\TypedDataInterface $parent * (optional) The parent object of the data property, or NULL if it is the * root of a typed data tree. Defaults to NULL. * * @see \Drupal\Core\TypedData\TypedDataManager::create() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
- public getPluginId() {@inheritdoc}$0['#user']->metatag->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0['#user']->metatag->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0['#user']->metatag->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0['#user']->metatag->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
- public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}$0['#user']->metatag->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0['#user']->metatag->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0['#user']->metatag->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0['#user']->metatag->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0['#user']->metatag->getParent()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/** * Translates a string to the current language or to a given language. * * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for * important security information and usage guidelines. * * In order for strings to be localized, make them available in one of the * ways supported by the * @link https://www.drupal.org/node/322729 Localization API @endlink. When * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait * $this->t(). Otherwise create a new * \Drupal\Core\StringTranslation\TranslatableMarkup object. * * @param string $string * A string containing the English text to translate. * @param array $args * (optional) An associative array of replacements to make after * translation. Based on the first character of the key, the value is * escaped and/or themed. See * \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for * details. * @param array $options * (optional) An associative array of additional options, with the following * elements: * - 'langcode' (defaults to the current language): A language code, to * translate to a language other than what is used to display the page. * - 'context' (defaults to the empty context): The context the source * string belongs to. See the * @link i18n Internationalization topic @endlink for more information * about string contexts. * * @return \Drupal\Core\StringTranslation\TranslatableMarkup * An object that, when cast to a string, returns the translated string. * * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat() * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() * * @ingroup sanitization */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
- protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/** * Formats a string containing a count of items. * * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
- protected getNumberOfPlurals($langcode = null) Returns the number of plurals supported by a given language.
/** * Returns the number of plurals supported by a given language. * * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
- protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/** * Gets the string translation service. * * @return \Drupal\Core\StringTranslation\TranslationInterface * The string translation service. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
- public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.$0['#user']->metatag->setStringTranslation()
/** * Sets the string translation service to use. * * @param \Drupal\Core\StringTranslation\TranslationInterface $translation * The string translation service. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
- public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.$0['#user']->metatag->setTypedDataManager()
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.$0['#user']->metatag->getTypedDataManager()
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- protected ensureComputedValue() Ensures that values are only computed once.
/** * Ensures that values are only computed once. */ Defined in <drupal>/modules/contrib/metatag/src/TypedData/ComputedItemListTrait.php:28
- public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:331
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0['#user']->metatag, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- counsellor_profile_profiles -> string (5) "13628"$0['#user']->counsellor_profile_profiles->target_id
- role_change -> string (37) "__role_delegation_empty_field_value__"$0['#user']->role_change->target_id
- path -> Drupal\pathauto\PathautoFieldItemList#5628 (10)$0['#user']->path
- Field (3)
- Properties (10)
- Methods (70)
- Static methods (2)
- Iterator
- alias -> string (19) "/listings/PChan.htm"$0['#user']->path->alias
- pid -> string (4) "5790"$0['#user']->path->pid
- langcode -> string (2) "en"$0['#user']->path->langcode
- alias -> string (19) "/listings/PChan.htm"
- protected definition -> Drupal\Core\Field\BaseFieldDefinition#1365 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1367 Depth Limit
- protected type -> string (4) "path"
- protected propertyDefinitions -> array (4) Depth Limit
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- protected name -> string (4) "path"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#1581 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#892 Blacklisted
- protected list -> array (1)
- 0 => Drupal\pathauto\PathautoItem#7037 Depth Limit
- protected langcode -> string (2) "en"
- protected valueComputed -> boolean true
- protected delegateMethod($method)
/** * @{inheritdoc} */ Defined in <drupal>/modules/contrib/pathauto/src/PathautoFieldItemList.php:12
- protected computeValue()
/** * @{inheritdoc} */ Defined in <drupal>/modules/contrib/pathauto/src/PathautoFieldItemList.php:32
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0['#user']->path->defaultAccess()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:47
- public delete() {@inheritdoc}$0['#user']->path->delete()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:57
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:40
- public getEntity() {@inheritdoc}$0['#user']->path->getEntity()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:47
- public setLangcode($langcode) {@inheritdoc}$0['#user']->path->setLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:56
- public getLangcode() {@inheritdoc}$0['#user']->path->getLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:63
- public getFieldDefinition() {@inheritdoc}$0['#user']->path->getFieldDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:70
- public getSettings() {@inheritdoc}$0['#user']->path->getSettings()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:77
- public getSetting($setting_name) {@inheritdoc}$0['#user']->path->getSetting()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:84
- public filterEmptyItems() {@inheritdoc}$0['#user']->path->filterEmptyItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:91
- public setValue($values, $notify = true) {@inheritdoc}$0['#user']->path->setValue()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:113
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:123
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:133
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:143
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0['#user']->path->access()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
- public applyDefaultValue($notify = true) {@inheritdoc}$0['#user']->path->applyDefaultValue()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:148
- public preSave() {@inheritdoc}$0['#user']->path->preSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
- public postSave($update) {@inheritdoc}$0['#user']->path->postSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
- public deleteRevision() {@inheritdoc}$0['#user']->path->deleteRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:212
- public view($display_options = array()) {@inheritdoc}$0['#user']->path->view()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
- public generateSampleItems($count = 1) {@inheritdoc}$0['#user']->path->generateSampleItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
- public getConstraints() {@inheritdoc}$0['#user']->path->getConstraints()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->path->defaultValuesForm()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
- public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->path->defaultValuesFormValidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:300
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->path->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:319
- protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/** * Returns the widget object used in default value form. * * @param \Drupal\Core\Form\FormStateInterface $form_state * The form state of the (entire) configuration form. * * @return \Drupal\Core\Field\WidgetInterface|null * A Widget object or NULL if no widget is available. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0['#user']->path->equals()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0['#user']->path->hasAffectingChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
- public getValue() {@inheritdoc}$0['#user']->path->getValue()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
- public getString() {@inheritdoc}$0['#user']->path->getString()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
- public get($index) {@inheritdoc}$0['#user']->path->get()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
- public set($index, $value) {@inheritdoc}$0['#user']->path->set()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
- public removeItem($index) {@inheritdoc}$0['#user']->path->removeItem()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:105
- protected rekey($from_index = 0) Renumbers the items in the list.
/** * Renumbers the items in the list. * * @param int $from_index * Optionally, the index at which to start the renumbering, if it is known * that items before that can safely be skipped (for example, when removing * an item at a given index). */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:154
- public first() {@inheritdoc}$0['#user']->path->first()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:167
- public offsetExists($offset) {@inheritdoc}$0['#user']->path->offsetExists()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:122
- public offsetUnset($offset) {@inheritdoc}$0['#user']->path->offsetUnset()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:184
- public offsetGet($offset) {@inheritdoc}$0['#user']->path->offsetGet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:192
- public offsetSet($offset, $value) {@inheritdoc}$0['#user']->path->offsetSet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
- public appendItem($value = null) {@inheritdoc}$0['#user']->path->appendItem()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
- public getItemDefinition() {@inheritdoc}$0['#user']->path->getItemDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:232
- public getIterator() {@inheritdoc}$0['#user']->path->getIterator()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:131
- public count() {@inheritdoc}$0['#user']->path->count()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:140
- public isEmpty() {@inheritdoc}$0['#user']->path->isEmpty()
/** * {@inheritdoc} */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
- public filter($callback) {@inheritdoc}$0['#user']->path->filter()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:273
- public onChange($delta) {@inheritdoc}$0['#user']->path->onChange()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:295
- public __clone() Magic method: Implements a deep clone.clone $0['#user']->path
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:305
- public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.new \Drupal\pathauto\PathautoFieldItemList()
/** * Constructs a TypedData object given its definition and context. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * The data definition. * @param string $name * (optional) The name of the created property, or NULL if it is the root * of a typed data tree. Defaults to NULL. * @param \Drupal\Core\TypedData\TypedDataInterface $parent * (optional) The parent object of the data property, or NULL if it is the * root of a typed data tree. Defaults to NULL. * * @see \Drupal\Core\TypedData\TypedDataManager::create() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
- public getPluginId() {@inheritdoc}$0['#user']->path->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0['#user']->path->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0['#user']->path->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0['#user']->path->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
- public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}$0['#user']->path->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0['#user']->path->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0['#user']->path->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0['#user']->path->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0['#user']->path->getParent()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/** * Translates a string to the current language or to a given language. * * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for * important security information and usage guidelines. * * In order for strings to be localized, make them available in one of the * ways supported by the * @link https://www.drupal.org/node/322729 Localization API @endlink. When * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait * $this->t(). Otherwise create a new * \Drupal\Core\StringTranslation\TranslatableMarkup object. * * @param string $string * A string containing the English text to translate. * @param array $args * (optional) An associative array of replacements to make after * translation. Based on the first character of the key, the value is * escaped and/or themed. See * \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for * details. * @param array $options * (optional) An associative array of additional options, with the following * elements: * - 'langcode' (defaults to the current language): A language code, to * translate to a language other than what is used to display the page. * - 'context' (defaults to the empty context): The context the source * string belongs to. See the * @link i18n Internationalization topic @endlink for more information * about string contexts. * * @return \Drupal\Core\StringTranslation\TranslatableMarkup * An object that, when cast to a string, returns the translated string. * * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat() * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() * * @ingroup sanitization */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
- protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/** * Formats a string containing a count of items. * * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
- protected getNumberOfPlurals($langcode = null) Returns the number of plurals supported by a given language.
/** * Returns the number of plurals supported by a given language. * * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
- protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/** * Gets the string translation service. * * @return \Drupal\Core\StringTranslation\TranslationInterface * The string translation service. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
- public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.$0['#user']->path->setStringTranslation()
/** * Sets the string translation service to use. * * @param \Drupal\Core\StringTranslation\TranslationInterface $translation * The string translation service. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
- public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.$0['#user']->path->setTypedDataManager()
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.$0['#user']->path->getTypedDataManager()
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- protected ensureComputedValue() Ensures that values are only computed once.
/** * Ensures that values are only computed once. */ Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32
- public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:331
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0['#user']->path, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- field_metatag -> string (13) "{"robots":""}"$0['#user']->field_metatag->value
- Json (1)
- robots => string (0) ""json_decode($0['#user']->field_metatag->value, true)['robots']
- robots => string (0) ""
- field_user_referred_by -> Drupal\Core\Field\EntityReferenceFieldItemList#5751 (9)$0['#user']->field_user_referred_by
- No values
- Properties (9)
- Methods (69)
- Static methods (3)
- Iterator
- No values uninitialized
- protected definition -> Drupal\field\Entity\FieldConfig#1369 (36)
- Properties (36)
- Methods (119)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- 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 originalId -> string (32) "user.user.field_user_referred_by"
- protected status -> boolean true
- protected uuid -> string (36) "a9c2c647-f5a9-456b-b07c-819073c0f347"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "en"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (32) "user.user.field_user_referred_by"
- protected field_name -> string (22) "field_user_referred_by"
- protected field_type -> string (16) "entity_reference"
- protected entity_type -> string (4) "user"
- protected bundle -> string (4) "user"
- protected label -> string (11) "Referred by"
- protected description -> string (76) "Please provide the name of the person who has referred you to CounsellingBC."
- protected settings -> array (2) Depth Limit
- 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 deleted -> boolean false
- public original -> uninitialized
- 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:108
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:163
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:199
- protected linkTemplates() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:262
- protected urlRouteParameters($rel) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:278
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:289
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:296
- public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:330
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:337
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:345
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:352
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:359
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:325
- public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:333
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:341
- public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:349
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:357
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:366
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:374
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:382
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:390
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:402
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:410
- public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:443
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:451
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:459
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:466
- 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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
- public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
- public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
- public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
- public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- 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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- 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 <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- 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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- 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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/** * Returns the typed data class name for this entity. * * @return string * The string representing the typed data class name. * * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:619
- public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:209
- public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:235
- public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:377
- public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
- public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
- public static 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.
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- protected static Drupal\Core\Field\FieldConfigBase::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:296
- public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:431
- public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:425
- protected static Drupal\Core\Entity\EntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- protected name -> string (22) "field_user_referred_by"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#1581 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#892 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "en"
- public getConstraints() {@inheritdoc}$0['#user']->field_user_referred_by->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
- public referencedEntities() {@inheritdoc}$0['#user']->field_user_referred_by->referencedEntities()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->field_user_referred_by->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:40
- public getEntity() {@inheritdoc}$0['#user']->field_user_referred_by->getEntity()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:47
- public setLangcode($langcode) {@inheritdoc}$0['#user']->field_user_referred_by->setLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:56
- public getLangcode() {@inheritdoc}$0['#user']->field_user_referred_by->getLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:63
- public getFieldDefinition() {@inheritdoc}$0['#user']->field_user_referred_by->getFieldDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:70
- public getSettings() {@inheritdoc}$0['#user']->field_user_referred_by->getSettings()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:77
- public getSetting($setting_name) {@inheritdoc}$0['#user']->field_user_referred_by->getSetting()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:84
- public filterEmptyItems() {@inheritdoc}$0['#user']->field_user_referred_by->filterEmptyItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:91
- public setValue($values, $notify = true) {@inheritdoc}$0['#user']->field_user_referred_by->setValue()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:101
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:113
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:123
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:133
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:143
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0['#user']->field_user_referred_by->access()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0['#user']->field_user_referred_by->defaultAccess()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
- public applyDefaultValue($notify = true) {@inheritdoc}$0['#user']->field_user_referred_by->applyDefaultValue()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
- public preSave() {@inheritdoc}$0['#user']->field_user_referred_by->preSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
- public postSave($update) {@inheritdoc}$0['#user']->field_user_referred_by->postSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
- public delete() {@inheritdoc}$0['#user']->field_user_referred_by->delete()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
- public deleteRevision() {@inheritdoc}$0['#user']->field_user_referred_by->deleteRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:212
- protected delegateMethod($method): array Calls a method on each FieldItem.
/** * Calls a method on each FieldItem. * * Any argument passed will be forwarded to the invoked method. * * @param string $method * The name of the method to be invoked. * * @return array * An array of results keyed by delta. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
- public view($display_options = array()) {@inheritdoc}$0['#user']->field_user_referred_by->view()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
- public generateSampleItems($count = 1) {@inheritdoc}$0['#user']->field_user_referred_by->generateSampleItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->field_user_referred_by->defaultValuesForm()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
- public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->field_user_referred_by->defaultValuesFormValidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:300
- protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/** * Returns the widget object used in default value form. * * @param \Drupal\Core\Form\FormStateInterface $form_state * The form state of the (entire) configuration form. * * @return \Drupal\Core\Field\WidgetInterface|null * A Widget object or NULL if no widget is available. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0['#user']->field_user_referred_by->equals()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0['#user']->field_user_referred_by->hasAffectingChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
- public getValue() {@inheritdoc}$0['#user']->field_user_referred_by->getValue()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:41
- public getString() {@inheritdoc}$0['#user']->field_user_referred_by->getString()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:90
- public get($index) {@inheritdoc}$0['#user']->field_user_referred_by->get()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:102
- public set($index, $value) {@inheritdoc}$0['#user']->field_user_referred_by->set()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:112
- public removeItem($index) {@inheritdoc}$0['#user']->field_user_referred_by->removeItem()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:134
- protected rekey($from_index = 0) Renumbers the items in the list.
/** * Renumbers the items in the list. * * @param int $from_index * Optionally, the index at which to start the renumbering, if it is known * that items before that can safely be skipped (for example, when removing * an item at a given index). */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:154
- public first() {@inheritdoc}$0['#user']->field_user_referred_by->first()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:167
- public offsetExists($offset) {@inheritdoc}$0['#user']->field_user_referred_by->offsetExists()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:175
- public offsetUnset($offset) {@inheritdoc}$0['#user']->field_user_referred_by->offsetUnset()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:184
- public offsetGet($offset) {@inheritdoc}$0['#user']->field_user_referred_by->offsetGet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:192
- public offsetSet($offset, $value) {@inheritdoc}$0['#user']->field_user_referred_by->offsetSet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
- public appendItem($value = null) {@inheritdoc}$0['#user']->field_user_referred_by->appendItem()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213
- public getItemDefinition() {@inheritdoc}$0['#user']->field_user_referred_by->getItemDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:232
- public getIterator() {@inheritdoc}$0['#user']->field_user_referred_by->getIterator()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240
- public count() {@inheritdoc}$0['#user']->field_user_referred_by->count()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:248
- public isEmpty() {@inheritdoc}$0['#user']->field_user_referred_by->isEmpty()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:255
- public filter($callback) {@inheritdoc}$0['#user']->field_user_referred_by->filter()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:273
- public onChange($delta) {@inheritdoc}$0['#user']->field_user_referred_by->onChange()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:295
- public __clone() Magic method: Implements a deep clone.clone $0['#user']->field_user_referred_by
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:305
- public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.new \Drupal\Core\Field\EntityReferenceFieldItemList()
/** * Constructs a TypedData object given its definition and context. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * The data definition. * @param string $name * (optional) The name of the created property, or NULL if it is the root * of a typed data tree. Defaults to NULL. * @param \Drupal\Core\TypedData\TypedDataInterface $parent * (optional) The parent object of the data property, or NULL if it is the * root of a typed data tree. Defaults to NULL. * * @see \Drupal\Core\TypedData\TypedDataManager::create() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
- public getPluginId() {@inheritdoc}$0['#user']->field_user_referred_by->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0['#user']->field_user_referred_by->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0['#user']->field_user_referred_by->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0['#user']->field_user_referred_by->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
- public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}$0['#user']->field_user_referred_by->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0['#user']->field_user_referred_by->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0['#user']->field_user_referred_by->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0['#user']->field_user_referred_by->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0['#user']->field_user_referred_by->getParent()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/** * Translates a string to the current language or to a given language. * * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for * important security information and usage guidelines. * * In order for strings to be localized, make them available in one of the * ways supported by the * @link https://www.drupal.org/node/322729 Localization API @endlink. When * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait * $this->t(). Otherwise create a new * \Drupal\Core\StringTranslation\TranslatableMarkup object. * * @param string $string * A string containing the English text to translate. * @param array $args * (optional) An associative array of replacements to make after * translation. Based on the first character of the key, the value is * escaped and/or themed. See * \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for * details. * @param array $options * (optional) An associative array of additional options, with the following * elements: * - 'langcode' (defaults to the current language): A language code, to * translate to a language other than what is used to display the page. * - 'context' (defaults to the empty context): The context the source * string belongs to. See the * @link i18n Internationalization topic @endlink for more information * about string contexts. * * @return \Drupal\Core\StringTranslation\TranslatableMarkup * An object that, when cast to a string, returns the translated string. * * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat() * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() * * @ingroup sanitization */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
- protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/** * Formats a string containing a count of items. * * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
- protected getNumberOfPlurals($langcode = null) Returns the number of plurals supported by a given language.
/** * Returns the number of plurals supported by a given language. * * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
- protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/** * Gets the string translation service. * * @return \Drupal\Core\StringTranslation\TranslationInterface * The string translation service. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
- public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.$0['#user']->field_user_referred_by->setStringTranslation()
/** * Sets the string translation service to use. * * @param \Drupal\Core\StringTranslation\TranslationInterface $translation * The string translation service. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
- public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.$0['#user']->field_user_referred_by->setTypedDataManager()
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.$0['#user']->field_user_referred_by->getTypedDataManager()
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getConstraints() {@inheritdoc}
- public static Drupal\Core\Field\EntityReferenceFieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:62
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:331
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0['#user']->field_user_referred_by, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- user_picture -> Drupal\file\Plugin\Field\FieldType\FileFieldItemList#5753 (9)$0['#user']->user_picture
- No values
- Properties (9)
- Methods (69)
- Static methods (3)
- Iterator
- No values uninitialized
- protected definition -> Drupal\field\Entity\FieldConfig#1370 (36)
- Properties (36)
- Methods (119)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- 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 originalId -> string (22) "user.user.user_picture"
- protected status -> boolean true
- protected uuid -> string (36) "a3aaa944-cbcf-462b-8e89-2399e02f24a9"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "en"
- protected third_party_settings -> array (0)
- protected _core -> array (1) Depth Limit
- protected trustedData -> boolean false
- protected dependencies -> array (2) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (22) "user.user.user_picture"
- protected field_name -> string (12) "user_picture"
- protected field_type -> string (5) "image"
- protected entity_type -> string (4) "user"
- protected bundle -> string (4) "user"
- protected label -> string (7) "Picture"
- protected description -> string (29) "Your virtual face or picture."
- protected settings -> array (12) Depth Limit
- 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 deleted -> boolean false
- public original -> uninitialized
- 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:108
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:163
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:199
- protected linkTemplates() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:262
- protected urlRouteParameters($rel) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:278
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:289
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:296
- public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:330
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:337
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:345
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:352
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:359
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:325
- public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:333
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:341
- public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:349
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:357
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:366
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:374
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:382
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:390
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:402
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:410
- public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:443
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:451
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:459
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:466
- 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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
- public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
- public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
- public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
- public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- 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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- 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 <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- 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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- 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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/** * Returns the typed data class name for this entity. * * @return string * The string representing the typed data class name. * * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:619
- public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:209
- public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:235
- public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:377
- public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
- public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
- public static 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.
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- protected static Drupal\Core\Field\FieldConfigBase::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:296
- public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:431
- public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:425
- protected static Drupal\Core\Entity\EntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- protected name -> string (12) "user_picture"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#1581 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#892 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "en"
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->user_picture->defaultValuesForm()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:16
- public postSave($update) {@inheritdoc}$0['#user']->user_picture->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:21
- public delete() {@inheritdoc}$0['#user']->user_picture->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:80
- public deleteRevision() {@inheritdoc}$0['#user']->user_picture->deleteRevision()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:95
- public getConstraints() {@inheritdoc}$0['#user']->user_picture->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
- public referencedEntities() {@inheritdoc}$0['#user']->user_picture->referencedEntities()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->user_picture->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:40
- public getEntity() {@inheritdoc}$0['#user']->user_picture->getEntity()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:47
- public setLangcode($langcode) {@inheritdoc}$0['#user']->user_picture->setLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:56
- public getLangcode() {@inheritdoc}$0['#user']->user_picture->getLangcode()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:63
- public getFieldDefinition() {@inheritdoc}$0['#user']->user_picture->getFieldDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:70
- public getSettings() {@inheritdoc}$0['#user']->user_picture->getSettings()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:77
- public getSetting($setting_name) {@inheritdoc}$0['#user']->user_picture->getSetting()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:84
- public filterEmptyItems() {@inheritdoc}$0['#user']->user_picture->filterEmptyItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:91
- public setValue($values, $notify = true) {@inheritdoc}$0['#user']->user_picture->setValue()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:101
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:113
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:123
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:133
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:143
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0['#user']->user_picture->access()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0['#user']->user_picture->defaultAccess()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
- public applyDefaultValue($notify = true) {@inheritdoc}$0['#user']->user_picture->applyDefaultValue()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
- public preSave() {@inheritdoc}$0['#user']->user_picture->preSave()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
- protected delegateMethod($method): array Calls a method on each FieldItem.
/** * Calls a method on each FieldItem. * * Any argument passed will be forwarded to the invoked method. * * @param string $method * The name of the method to be invoked. * * @return array * An array of results keyed by delta. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
- public view($display_options = array()) {@inheritdoc}$0['#user']->user_picture->view()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
- public generateSampleItems($count = 1) {@inheritdoc}$0['#user']->user_picture->generateSampleItems()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
- public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0['#user']->user_picture->defaultValuesFormValidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:300
- protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/** * Returns the widget object used in default value form. * * @param \Drupal\Core\Form\FormStateInterface $form_state * The form state of the (entire) configuration form. * * @return \Drupal\Core\Field\WidgetInterface|null * A Widget object or NULL if no widget is available. */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0['#user']->user_picture->equals()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0['#user']->user_picture->hasAffectingChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
- public getValue() {@inheritdoc}$0['#user']->user_picture->getValue()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:41
- public getString() {@inheritdoc}$0['#user']->user_picture->getString()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:90
- public get($index) {@inheritdoc}$0['#user']->user_picture->get()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:102
- public set($index, $value) {@inheritdoc}$0['#user']->user_picture->set()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:112
- public removeItem($index) {@inheritdoc}$0['#user']->user_picture->removeItem()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:134
- protected rekey($from_index = 0) Renumbers the items in the list.
/** * Renumbers the items in the list. * * @param int $from_index * Optionally, the index at which to start the renumbering, if it is known * that items before that can safely be skipped (for example, when removing * an item at a given index). */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:154
- public first() {@inheritdoc}$0['#user']->user_picture->first()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:167
- public offsetExists($offset) {@inheritdoc}$0['#user']->user_picture->offsetExists()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:175
- public offsetUnset($offset) {@inheritdoc}$0['#user']->user_picture->offsetUnset()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:184
- public offsetGet($offset) {@inheritdoc}$0['#user']->user_picture->offsetGet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:192
- public offsetSet($offset, $value) {@inheritdoc}$0['#user']->user_picture->offsetSet()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
- public appendItem($value = null) {@inheritdoc}$0['#user']->user_picture->appendItem()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213
- public getItemDefinition() {@inheritdoc}$0['#user']->user_picture->getItemDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:232
- public getIterator() {@inheritdoc}$0['#user']->user_picture->getIterator()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240
- public count() {@inheritdoc}$0['#user']->user_picture->count()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:248
- public isEmpty() {@inheritdoc}$0['#user']->user_picture->isEmpty()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:255
- public filter($callback) {@inheritdoc}$0['#user']->user_picture->filter()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:273
- public onChange($delta) {@inheritdoc}$0['#user']->user_picture->onChange()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:295
- public __clone() Magic method: Implements a deep clone.clone $0['#user']->user_picture
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:305
- public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.new \Drupal\file\Plugin\Field\FieldType\FileFieldItemList()
/** * Constructs a TypedData object given its definition and context. * * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition * The data definition. * @param string $name * (optional) The name of the created property, or NULL if it is the root * of a typed data tree. Defaults to NULL. * @param \Drupal\Core\TypedData\TypedDataInterface $parent * (optional) The parent object of the data property, or NULL if it is the * root of a typed data tree. Defaults to NULL. * * @see \Drupal\Core\TypedData\TypedDataManager::create() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
- public getPluginId() {@inheritdoc}$0['#user']->user_picture->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0['#user']->user_picture->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0['#user']->user_picture->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0['#user']->user_picture->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
- public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}$0['#user']->user_picture->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0['#user']->user_picture->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0['#user']->user_picture->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0['#user']->user_picture->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0['#user']->user_picture->getParent()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/** * Translates a string to the current language or to a given language. * * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for * important security information and usage guidelines. * * In order for strings to be localized, make them available in one of the * ways supported by the * @link https://www.drupal.org/node/322729 Localization API @endlink. When * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait * $this->t(). Otherwise create a new * \Drupal\Core\StringTranslation\TranslatableMarkup object. * * @param string $string * A string containing the English text to translate. * @param array $args * (optional) An associative array of replacements to make after * translation. Based on the first character of the key, the value is * escaped and/or themed. See * \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for * details. * @param array $options * (optional) An associative array of additional options, with the following * elements: * - 'langcode' (defaults to the current language): A language code, to * translate to a language other than what is used to display the page. * - 'context' (defaults to the empty context): The context the source * string belongs to. See the * @link i18n Internationalization topic @endlink for more information * about string contexts. * * @return \Drupal\Core\StringTranslation\TranslatableMarkup * An object that, when cast to a string, returns the translated string. * * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat() * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() * * @ingroup sanitization */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
- protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/** * Formats a string containing a count of items. * * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
- protected getNumberOfPlurals($langcode = null) Returns the number of plurals supported by a given language.
/** * Returns the number of plurals supported by a given language. * * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals() */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
- protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/** * Gets the string translation service. * * @return \Drupal\Core\StringTranslation\TranslationInterface * The string translation service. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
- public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.$0['#user']->user_picture->setStringTranslation()
/** * Sets the string translation service to use. * * @param \Drupal\Core\StringTranslation\TranslationInterface $translation * The string translation service. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
- public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.$0['#user']->user_picture->setTypedDataManager()
/** * Sets the typed data manager. * * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager * The typed data manager. * * @return $this */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
- public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.$0['#user']->user_picture->getTypedDataManager()
/** * Gets the typed data manager. * * @return \Drupal\Core\TypedData\TypedDataManagerInterface * The typed data manager. */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
- public static Drupal\Core\Field\EntityReferenceFieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:62
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:331
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0['#user']->user_picture, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- uid -> string (4) "6398"
- protected entityTypeId -> string (4) "user"
- protected enforceIsNew -> null
- protected typedData -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#1581 Blacklisted
- protected cacheContexts -> array (0)
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected values -> array (18)
- uid => array (1)
- x-default => string (4) "6398"
- uuid => array (1)
- x-default => string (36) "8e7b6131-4367-4c70-a3f9-42d9265546ff"
- langcode => array (1)
- x-default => string (2) "en"
- preferred_langcode => array (1)
- x-default => string (2) "en"
- preferred_admin_langcode => array (1)
- x-default => string (2) "en"
- name => array (1)
- x-default => string (12) "Phyllis Chan"
- pass => array (1)
- x-default => string (55) "$S$Dv/B94eP3SUiNTMMexQ5BhmiiB/Rn2h5sbH6VrWUd0AP5P/CX/yN"
- mail => array (1)
- x-default => string (27) "pchan@horizoncounselling.ca"
- timezone => array (1)
- x-default => string (17) "America/Vancouver"
- status => array (1)
- x-default => string (1) "1"
- created => array (1)
- x-default => string (10) "1611609074"
2021-01-25T21:11:14+00:00
- changed => array (1)
- x-default => string (10) "1752188199"
2025-07-10T22:56:39+00:00
- access => array (1)
- x-default => string (10) "1750272695"
2025-06-18T18:51:35+00:00
- login => array (1)
- x-default => string (10) "1750272059"
2025-06-18T18:40:59+00:00
- init => array (1)
- x-default => string (27) "pchan@horizoncounselling.ca"
- default_langcode => array (1)
- x-default => string (1) "1"
- roles => array (1)
- x-default => array (1) Depth Limit
- field_metatag => array (1)
- x-default => array (1) Depth Limit
- protected fields -> array (2)
- role_change => array (1)
- x-default => Drupal\Core\Field\EntityReferenceFieldItemList#1583 Blacklisted
- roles => array (1)
- x-default => Drupal\Core\Field\EntityReferenceFieldItemList#1595 Blacklisted
- protected fieldDefinitions -> array (24)
- uid => Drupal\Core\Field\BaseFieldDefinition#1280 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1285 Depth Limit
- protected type -> string (7) "integer"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- uuid => Drupal\Core\Field\BaseFieldDefinition#1286 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1289 Depth Limit
- protected type -> string (4) "uuid"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- langcode => Drupal\Core\Field\BaseFieldDefinition#1290 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1293 Depth Limit
- protected type -> string (8) "language"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- preferred_langcode => Drupal\Core\Field\BaseFieldDefinition#1294 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (6) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1297 Depth Limit
- protected type -> string (8) "language"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- preferred_admin_langcode => Drupal\Core\Field\BaseFieldDefinition#1298 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1301 Depth Limit
- protected type -> string (8) "language"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- name => Drupal\Core\Field\BaseFieldDefinition#1302 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1305 Depth Limit
- protected type -> string (6) "string"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- pass => Drupal\Core\Field\BaseFieldDefinition#1306 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1309 Depth Limit
- protected type -> string (8) "password"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- mail => Drupal\Core\Field\BaseFieldDefinition#1310 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1313 Depth Limit
- protected type -> string (5) "email"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- timezone => Drupal\Core\Field\BaseFieldDefinition#1314 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (6) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1317 Depth Limit
- protected type -> string (6) "string"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- status => Drupal\Core\Field\BaseFieldDefinition#1318 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1321 Depth Limit
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- created => Drupal\Core\Field\BaseFieldDefinition#1324 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (6) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1327 Depth Limit
- protected type -> string (7) "created"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- changed => Drupal\Core\Field\BaseFieldDefinition#1328 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1331 Depth Limit
- protected type -> string (7) "changed"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- access => Drupal\Core\Field\BaseFieldDefinition#1332 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1335 Depth Limit
- protected type -> string (9) "timestamp"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- login => Drupal\Core\Field\BaseFieldDefinition#1336 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1339 Depth Limit
- protected type -> string (9) "timestamp"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- init => Drupal\Core\Field\BaseFieldDefinition#1340 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1343 Depth Limit
- protected type -> string (5) "email"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- roles => Drupal\Core\Field\BaseFieldDefinition#1344 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1347 Depth Limit
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> array (2) Depth Limit
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- default_langcode => Drupal\Core\Field\BaseFieldDefinition#1348 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1351 Depth Limit
- protected type -> string (7) "boolean"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- metatag => Drupal\Core\Field\BaseFieldDefinition#1354 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1357 Depth Limit
- protected type -> string (16) "metatag_computed"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- counsellor_profile_profiles => Drupal\Core\Field\BaseFieldDefinition#1358 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1361 Depth Limit
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- role_change => Drupal\Core\Field\BaseFieldDefinition#1362 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1364 Depth Limit
- protected type -> string (16) "entity_reference"
- protected propertyDefinitions -> array (2) Depth Limit
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- path => Drupal\Core\Field\BaseFieldDefinition#1365 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9) Depth Limit
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1367 Depth Limit
- protected type -> string (4) "path"
- protected propertyDefinitions -> null
- protected schema -> null
- protected indexes -> array (0)
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
- public isDisplayConfigurable($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:551
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:635
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:655
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:721
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:771
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779
- public isStorageRequired() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:808
- public __clone() Magic method: Implements a deep clone.
/** * Magic method: Implements a deep clone. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
- public setDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\DataDefinition Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:400
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
- public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/** * Creates a new field definition. * * @param string $type * The type of the field. * * @return static * A new field definition object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
- public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage 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 <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
- public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
- public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
- protected static Drupal\Core\Field\BaseFieldDefinition::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/** * Creates a new list definition. * * @param string $item_type * The data type of the list items; e.g., 'string', 'integer' or 'any'. * * @return static * A new List Data Definition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
- public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
- public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/** * Creates a new data definition. * * @param string $type * The data type of the data; e.g., 'string', 'integer' or 'any'. * * @return static * A new DataDefinition object. */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
- public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- field_metatag => Drupal\field\Entity\FieldConfig#1368 (36)
- Properties (36)
- Methods (119)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- 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 originalId -> string (23) "user.user.field_metatag"
- protected status -> boolean true
- protected uuid -> string (36) "3b3515a6-3a9f-4348-932f-8c37d28de2d6"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "en"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (23) "user.user.field_metatag"
- protected field_name -> string (13) "field_metatag"
- protected field_type -> string (7) "metatag"
- protected entity_type -> string (4) "user"
- protected bundle -> string (4) "user"
- protected label -> string (9) "Meta tags"
- 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 deleted -> boolean false
- public original -> uninitialized
- 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:108
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:163
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:199
- protected linkTemplates() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:262
- protected urlRouteParameters($rel) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:278
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:289
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:296
- public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:330
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:337
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:345
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:352
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:359
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:325
- public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:333
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:341
- public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:349
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:357
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:366
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:374
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:382
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:390
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:402
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:410
- public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:443
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:451
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:459
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:466
- 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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
- public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
- public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
- public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
- public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- 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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- 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 <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- 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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- 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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/** * Returns the typed data class name for this entity. * * @return string * The string representing the typed data class name. * * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:619
- public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:209
- public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:235
- public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:377
- public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
- public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
- public static 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.
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- protected static Drupal\Core\Field\FieldConfigBase::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:296
- public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:431
- public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:425
- protected static Drupal\Core\Entity\EntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- field_user_referred_by => Drupal\field\Entity\FieldConfig#1369 (36)
- Properties (36)
- Methods (119)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- 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 originalId -> string (32) "user.user.field_user_referred_by"
- protected status -> boolean true
- protected uuid -> string (36) "a9c2c647-f5a9-456b-b07c-819073c0f347"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "en"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (32) "user.user.field_user_referred_by"
- protected field_name -> string (22) "field_user_referred_by"
- protected field_type -> string (16) "entity_reference"
- protected entity_type -> string (4) "user"
- protected bundle -> string (4) "user"
- protected label -> string (11) "Referred by"
- protected description -> string (76) "Please provide the name of the person who has referred you to CounsellingBC."
- protected settings -> array (2) Depth Limit
- 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 deleted -> boolean false
- public original -> uninitialized
- 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:108
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:163
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:199
- protected linkTemplates() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:262
- protected urlRouteParameters($rel) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:278
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:289
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:296
- public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:330
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:337
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:345
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:352
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:359
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:325
- public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:333
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:341
- public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:349
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:357
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:366
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:374
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:382
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:390
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:402
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:410
- public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:443
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:451
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:459
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:466
- 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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
- public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
- public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
- public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
- public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- 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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- 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 <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- 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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- 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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/** * Returns the typed data class name for this entity. * * @return string * The string representing the typed data class name. * * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:619
- public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:209
- public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:235
- public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:377
- public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
- public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
- public static 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.
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- protected static Drupal\Core\Field\FieldConfigBase::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:296
- public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:431
- public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:425
- protected static Drupal\Core\Entity\EntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- user_picture => Drupal\field\Entity\FieldConfig#1370 (36)
- Properties (36)
- Methods (119)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- 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 originalId -> string (22) "user.user.user_picture"
- protected status -> boolean true
- protected uuid -> string (36) "a3aaa944-cbcf-462b-8e89-2399e02f24a9"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "en"
- protected third_party_settings -> array (0)
- protected _core -> array (1) Depth Limit
- protected trustedData -> boolean false
- protected dependencies -> array (2) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (22) "user.user.user_picture"
- protected field_name -> string (12) "user_picture"
- protected field_type -> string (5) "image"
- protected entity_type -> string (4) "user"
- protected bundle -> string (4) "user"
- protected label -> string (7) "Picture"
- protected description -> string (29) "Your virtual face or picture."
- protected settings -> array (12) Depth Limit
- 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 deleted -> boolean false
- public original -> uninitialized
- 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:108
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:163
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:199
- protected linkTemplates() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:262
- protected urlRouteParameters($rel) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:278
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:289
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:296
- public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:330
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:337
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:345
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:352
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:359
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:201
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:208
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:215
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:222
- public getTargetBundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:229
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:311
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:325
- public setLabel($label) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:333
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:341
- public setDescription($description) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:349
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:357
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:366
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:374
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:382
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:390
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:402
- public isRequired() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:410
- public setRequired($required) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
- public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
- public getDefaultValueLiteral() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:443
- public setDefaultValue($value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:451
- public getDefaultValueCallback() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:459
- public setDefaultValueCallback($callback) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:466
- 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 <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
- public getDataType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
- public isList() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
- public getItemDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
- public getConfig($bundle) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
- public setConstraints(array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
- public addConstraint($constraint_name, $options = null) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
- public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
- public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
- public isInternal() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
- public getOriginalId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:125
- public setOriginalId($id) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:149
- public get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:164
- public enable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
- public disable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:190
- public setStatus($status) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:198
- public status() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:206
- public setUninstalling($uninstalling) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:213
- public isUninstalling() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:220
- public createDuplicate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:227
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:252
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:287
- public toUrl($rel = null, array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:405
- public getCacheTagsToInvalidate() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:414
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:429
- public getDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:443
- public getConfigDependencyName() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:457
- public getConfigTarget() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:464
- 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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:491
- public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:521
- public getThirdPartySettings($module) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:533
- public unsetThirdPartySetting($module, $key) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:540
- public getThirdPartyProviders() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:553
- public isInstallable() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:594
- public trustData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:601
- public hasTrustedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:609
- public save() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:616
- 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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- public uuid() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:113
- public enforceIsNew($value = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- public getEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public bundle() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- public label() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:150
- public hasLinkTemplate($rel) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- public uriRelationships() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:321
- public language() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:335
- public delete() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- public getEntityType() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- public referencedEntities() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:444
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- public getTypedData() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- public getConfigDependencyKey() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- public addCacheableDependency($other_object) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- public addCacheContexts(array $cache_contexts) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- public addCacheTags(array $cache_tags) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- public mergeCacheMaxAge($max_age) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- 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 <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- public traitSleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- 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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
- 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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
- 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 <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
- public setSyncing($syncing) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/** * Returns the typed data class name for this entity. * * @return string * The string representing the typed data class name. * * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:619
- public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:209
- public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:235
- public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and 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 <drupal>/core/modules/field/src/Entity/FieldConfig.php:377
- public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
- public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
- public static 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.
/** * Helper callback for uasort() to sort configuration entities by weight and label. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:238
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:501
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/** * Gets the configuration manager. * * @return \Drupal\Core\Config\ConfigManager * The configuration manager. */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:587
- public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- protected static Drupal\Core\Field\FieldConfigBase::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 <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
- public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:296
- public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:560
- public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:431
- public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:425
- protected static Drupal\Core\Entity\EntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- protected languages -> array (3)
- en => Drupal\Core\Language\Language#340 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> string (7) "English"
- protected id -> string (2) "en"
- 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 <drupal>/core/lib/Drupal/Core/Language/Language.php:77
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
- public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
- public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
- public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
- public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
- public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
- public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
- protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
- public static Drupal\Core\Language\Language::$defaultValues :: array (5) Depth Limit
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
- public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
- public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
- public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
- public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
- public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
- public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
- public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
- public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
- public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"
- und => Drupal\Core\Language\Language#1685 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#1686 Depth Limit
- protected id -> string (3) "und"
- protected direction -> string (3) "ltr"
- protected weight -> integer 1
- 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 <drupal>/core/lib/Drupal/Core/Language/Language.php:77
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
- public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
- public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
- public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
- public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
- public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
- public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
- protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
- public static Drupal\Core\Language\Language::$defaultValues :: array (5) Depth Limit
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
- public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
- public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
- public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
- public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
- public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
- public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
- public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
- public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
- public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"
- zxx => Drupal\Core\Language\Language#1687 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#1688 Depth Limit
- protected id -> string (3) "zxx"
- 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 <drupal>/core/lib/Drupal/Core/Language/Language.php:77
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
- public getId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
- public getDirection() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
- public getWeight() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
- public isDefault() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
- public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
- public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/** * Sort language objects. * * @param \Drupal\Core\Language\LanguageInterface[] $languages * The array of language objects keyed by langcode. */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
- protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/** * Gets the default langcode. * * @return string * The current default langcode. */ Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
- public static Drupal\Core\Language\Language::$defaultValues :: array (5) Depth Limit
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
- public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
- public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
- public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
- public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
- public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
- public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
- public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
- public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
- public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
- public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"
- protected langcodeKey -> string (8) "langcode"
- protected defaultLangcodeKey -> string (16) "default_langcode"
- protected activeLangcode -> string (9) "x-default"
- protected enforceDefaultTranslation -> null
- protected defaultLangcode -> string (2) "en"
- protected translations -> array (1)
- x-default => array (2)
- status => integer 1
- entity => Drupal\user\Entity\User#1282 Recursion
- protected translationInitialize -> boolean false
- protected newRevision -> boolean false
- protected isDefaultRevision -> boolean true
- protected entityKeys -> array (3)
- bundle => string (4) "user"
- id => string (4) "6398"
- uuid => string (36) "8e7b6131-4367-4c70-a3f9-42d9265546ff"
- protected translatableEntityKeys -> array (2)
- langcode => array (1)
- x-default => string (2) "en"
- default_langcode => array (1)
- x-default => string (1) "1"
- protected validated -> boolean false
- protected validationRequired -> boolean false
- protected loadedRevisionId -> null
- protected revisionTranslationAffectedKey -> string (29) "revision_translation_affected"
- protected enforceRevisionTranslationAffected -> array (0)
- protected isSyncing -> boolean false
- public isNew() {@inheritdoc}$0['#user']->isNew()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:82
- public label() {@inheritdoc}$0['#user']->label()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:89
- public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}$0['#user']->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:96
- public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}$0['#user']->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:117
- public getRoles($exclude_locked_roles = false) {@inheritdoc}$0['#user']->getRoles()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:170
- public hasRole($rid) {@inheritdoc}$0['#user']->hasRole()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:195
- public addRole($rid) {@inheritdoc}$0['#user']->addRole()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:202
- public removeRole($rid) {@inheritdoc}$0['#user']->removeRole()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:218
- public hasPermission($permission) {@inheritdoc}$0['#user']->hasPermission()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:227
- public getPassword() {@inheritdoc}$0['#user']->getPassword()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:238
- public setPassword($password) {@inheritdoc}$0['#user']->setPassword()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:245
- public getEmail() {@inheritdoc}$0['#user']->getEmail()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:253
- public setEmail($mail) {@inheritdoc}$0['#user']->setEmail()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:260
- public getCreatedTime() {@inheritdoc}$0['#user']->getCreatedTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:268
- public getLastAccessedTime() {@inheritdoc}$0['#user']->getLastAccessedTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:275
- public setLastAccessTime($timestamp) {@inheritdoc}$0['#user']->setLastAccessTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:282
- public getLastLoginTime() {@inheritdoc}$0['#user']->getLastLoginTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:290
- public setLastLoginTime($timestamp) {@inheritdoc}$0['#user']->setLastLoginTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:297
- public isActive() {@inheritdoc}$0['#user']->isActive()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:305
- public isBlocked() {@inheritdoc}$0['#user']->isBlocked()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:312
- public activate() {@inheritdoc}$0['#user']->activate()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:319
- public block() {@inheritdoc}$0['#user']->block()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:330
- public getTimeZone() {@inheritdoc}$0['#user']->getTimeZone()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:338
- public getPreferredLangcode($fallback_to_default = true) {@inheritdoc}$0['#user']->getPreferredLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:345
- public getPreferredAdminLangcode($fallback_to_default = true) {@inheritdoc}$0['#user']->getPreferredAdminLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:359
- public getInitialEmail() {@inheritdoc}$0['#user']->getInitialEmail()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:373
- public isAuthenticated() {@inheritdoc}$0['#user']->isAuthenticated()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:380
- public isAnonymous() {@inheritdoc}$0['#user']->isAnonymous()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:387
- public getAccountName() {@inheritdoc}$0['#user']->getAccountName()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:394
- public getDisplayName() {@inheritdoc}$0['#user']->getDisplayName()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:401
- public setUsername($username) {@inheritdoc}$0['#user']->setUsername()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:410
- public setExistingPassword($password) {@inheritdoc}$0['#user']->setExistingPassword()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:418
- public checkExistingPassword(Drupal\user\UserInterface $account_unchanged) {@inheritdoc}$0['#user']->checkExistingPassword()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:426
- protected getRoleStorage(): \Drupal\user\RoleStorageInterface Returns the role storage object.
/** * Returns the role storage object. * * @return \Drupal\user\RoleStorageInterface * The role storage object. */ Defined in <drupal>/core/modules/user/src/Entity/User.php:579
- public __construct(array $values, $entity_type, $bundle = false, $translations = array()) {@inheritdoc}new \Drupal\user\Entity\User()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:201
- protected getLanguages() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:280
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}$0['#user']->postCreate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:296
- public setNewRevision($value = true) {@inheritdoc}$0['#user']->setNewRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:303
- public getLoadedRevisionId() {@inheritdoc}$0['#user']->getLoadedRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:325
- public updateLoadedRevisionId() {@inheritdoc}$0['#user']->updateLoadedRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:332
- public isNewRevision() {@inheritdoc}$0['#user']->isNewRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:340
- public isDefaultRevision($new_value = null) {@inheritdoc}$0['#user']->isDefaultRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:347
- public wasDefaultRevision() {@inheritdoc}$0['#user']->wasDefaultRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:360
- public isLatestRevision() {@inheritdoc}$0['#user']->isLatestRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:375
- public isLatestTranslationAffectedRevision() {@inheritdoc}$0['#user']->isLatestTranslationAffectedRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:385
- public isRevisionTranslationAffected() {@inheritdoc}$0['#user']->isRevisionTranslationAffected()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:395
- public setRevisionTranslationAffected($affected) {@inheritdoc}$0['#user']->setRevisionTranslationAffected()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:402
- public isRevisionTranslationAffectedEnforced() {@inheritdoc}$0['#user']->isRevisionTranslationAffectedEnforced()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:412
- public setRevisionTranslationAffectedEnforced($enforced) {@inheritdoc}$0['#user']->setRevisionTranslationAffectedEnforced()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/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['#user']->setDefaultTranslationEnforced()
/** * 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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:434
- public isDefaultTranslation() {@inheritdoc}$0['#user']->isDefaultTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:442
- public getRevisionId() {@inheritdoc}$0['#user']->getRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:452
- public isTranslatable() {@inheritdoc}$0['#user']->isTranslatable()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:459
- public preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record) {@inheritdoc}$0['#user']->preSaveRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:485
- public validate() {@inheritdoc}$0['#user']->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:516
- public isValidationRequired() {@inheritdoc}$0['#user']->isValidationRequired()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:525
- public setValidationRequired($required) {@inheritdoc}$0['#user']->setValidationRequired()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:532
- 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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:540
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:549
- public id() {@inheritdoc}$0['#user']->id()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:567
- public bundle() {@inheritdoc}$0['#user']->bundle()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:574
- public uuid() {@inheritdoc}$0['#user']->uuid()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:581
- public hasField($field_name) {@inheritdoc}$0['#user']->hasField()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:588
- public get($field_name) {@inheritdoc}$0['#user']->get()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:595
- 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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:607
- public set($name, $value, $notify = true) {@inheritdoc}$0['#user']->set()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:653
- public getFields($include_computed = true) {@inheritdoc}$0['#user']->getFields()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:664
- public getTranslatableFields($include_computed = true) {@inheritdoc}$0['#user']->getTranslatableFields()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:677
- public getIterator() {@inheritdoc}$0['#user']->getIterator()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:691
- public getFieldDefinition($name) {@inheritdoc}$0['#user']->getFieldDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:698
- public getFieldDefinitions() {@inheritdoc}$0['#user']->getFieldDefinitions()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:710
- public toArray() {@inheritdoc}$0['#user']->toArray()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:720
- public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0['#user']->access()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:731
- public language() {@inheritdoc}$0['#user']->language()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:745
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:800
- public onChange($name) {@inheritdoc}$0['#user']->onChange()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:811
- public getTranslation($langcode) {@inheritdoc}$0['#user']->getTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:877
- public getUntranslated() {@inheritdoc}$0['#user']->getUntranslated()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:912
- 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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:930
- public hasTranslation($langcode) {@inheritdoc}$0['#user']->hasTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:963
- public isNewTranslation() {@inheritdoc}$0['#user']->isNewTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:973
- public addTranslation($langcode, array $values = array()) {@inheritdoc}$0['#user']->addTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:980
- public removeTranslation($langcode) {@inheritdoc}$0['#user']->removeTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1001
- public getTranslationStatus($langcode) {@inheritdoc}$0['#user']->getTranslationStatus()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1030
- public getTranslationLanguages($include_default = true) {@inheritdoc}$0['#user']->getTranslationLanguages()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1040
- public updateOriginalValues() Updates the original values with the interim changes.$0['#user']->updateOriginalValues()
/** * Updates the original values with the interim changes. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1147
- public createDuplicate() {@inheritdoc}$0['#user']->createDuplicate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1178
- public __clone() Magic method: Implements a deep clone.clone $0['#user']
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1211
- public referencedEntities() {@inheritdoc}$0['#user']->referencedEntities()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1306
- 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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1435
- public hasTranslationChanges() {@inheritdoc}$0['#user']->hasTranslationChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1446
- public isDefaultTranslationAffectedOnly() {@inheritdoc}$0['#user']->isDefaultTranslationAffectedOnly()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1505
- 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 <drupal>/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 <drupal>/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 <drupal>/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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:99
- public enforceIsNew($value = true) {@inheritdoc}$0['#user']->enforceIsNew()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
- public getEntityTypeId() {@inheritdoc}$0['#user']->getEntityTypeId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public toUrl($rel = null, array $options = array()) {@inheritdoc}$0['#user']->toUrl()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
- public hasLinkTemplate($rel) {@inheritdoc}$0['#user']->hasLinkTemplate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:237
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:248
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}$0['#user']->toLink()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:255
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:278
- public uriRelationships() {@inheritdoc}$0['#user']->uriRelationships()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:299
- public save() {@inheritdoc}$0['#user']->save()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:352
- public delete() {@inheritdoc}$0['#user']->delete()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
- public getEntityType() {@inheritdoc}$0['#user']->getEntityType()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
- public getCacheContexts() {@inheritdoc}$0['#user']->getCacheContexts()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:451
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:461
- public getCacheTagsToInvalidate() {@inheritdoc}$0['#user']->getCacheTagsToInvalidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:472
- public getCacheTags() {@inheritdoc}$0['#user']->getCacheTags()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
- public getCacheMaxAge() {@inheritdoc}$0['#user']->getCacheMaxAge()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:492
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:532
- public getOriginalId() {@inheritdoc}$0['#user']->getOriginalId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:574
- public setOriginalId($id) {@inheritdoc}$0['#user']->setOriginalId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
- public getTypedData() {@inheritdoc}$0['#user']->getTypedData()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
- public getConfigDependencyKey() {@inheritdoc}$0['#user']->getConfigDependencyKey()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
- public getConfigDependencyName() {@inheritdoc}$0['#user']->getConfigDependencyName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:655
- public getConfigTarget() {@inheritdoc}$0['#user']->getConfigTarget()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:662
- public addCacheableDependency($other_object) {@inheritdoc}$0['#user']->addCacheableDependency()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
- public addCacheContexts(array $cache_contexts) {@inheritdoc}$0['#user']->addCacheContexts()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
- public addCacheTags(array $cache_tags) {@inheritdoc}$0['#user']->addCacheTags()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
- public mergeCacheMaxAge($max_age) {@inheritdoc}$0['#user']->mergeCacheMaxAge()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
- 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 <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
- public traitSleep() {@inheritdoc}$0['#user']->traitSleep()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- 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 <drupal>/core/lib/Drupal/Core/Entity/EntityChangesDetectionTrait.php:21
- public setSyncing($syncing) {@inheritdoc}$0['#user']->setSyncing()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}$0['#user']->isSyncing()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- public getChangedTimeAcrossTranslations(): int Returns the timestamp of the last entity change across all translations.$0['#user']->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. */ Defined in <drupal>/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['#user']->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. */ Defined in <drupal>/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['#user']->setChangedTime()
/** * 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 */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46
- private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/** * Returns the typed data class name for this entity. * * @return string * The string representing the typed data class name. * * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:619
- public isNew() {@inheritdoc}
- public static Drupal\user\Entity\User::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:160
- public static Drupal\user\Entity\User::getAnonymousUser(): \Drupal\user\UserInterface Returns an anonymous user entity.
/** * Returns an anonymous user entity. * * @return \Drupal\user\UserInterface * An anonymous user entity. */ Defined in <drupal>/core/modules/user/src/Entity/User.php:438
- public static Drupal\user\Entity\User::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/Entity/User.php:461
- public static Drupal\user\Entity\User::getAllowedTimezones(): string[] Defines allowed timezones for the field's AllowedValues constraint.
/** * Defines allowed timezones for the field's AllowedValues constraint. * * @return string[] * The allowed values. */ Defined in <drupal>/core/modules/user/src/Entity/User.php:589
- public static Drupal\user\Entity\User::getAllowedConfigurableLanguageCodes(): string[] Defines allowed configurable language codes for AllowedValues constraints.
/** * Defines allowed configurable language codes for AllowedValues constraints. * * @return string[] * The allowed values. */ Defined in <drupal>/core/modules/user/src/Entity/User.php:599
- public static Drupal\Core\Entity\ContentEntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1161
- public static Drupal\Core\Entity\ContentEntityBase::bundleFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1425
- public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:413
- public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:425
- public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:438
- public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:499
- public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:509
- protected static Drupal\Core\Entity\EntityBase::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. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
- public static Drupal\Core\Entity\ContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1367
- public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:431
- public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519
- protected static Drupal\user\Entity\User::$anonymousUser :: null
- protected static Drupal\Core\Entity\ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck :: array (0)
- public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_REMOVED :: integer 0
- public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_EXISTING :: integer 1
- public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_CREATED :: integer 2
- public const Drupal\user\UserInterface::USERNAME_MAX_LENGTH :: integer 60
- public const Drupal\user\UserInterface::REGISTER_ADMINISTRATORS_ONLY :: string (10) "admin_only"
- public const Drupal\user\UserInterface::REGISTER_VISITORS :: string (8) "visitors"
- public const Drupal\user\UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL :: string (23) "visitors_admin_approval"
- public const Drupal\user\UserInterface::TIMEZONE_DEFAULT :: integer 0
- public const Drupal\user\UserInterface::TIMEZONE_EMPTY :: integer 1
- public const Drupal\user\UserInterface::TIMEZONE_SELECT :: integer 2
- public const Drupal\Core\Session\AccountInterface::ANONYMOUS_ROLE :: string (9) "anonymous"
- public const Drupal\Core\Session\AccountInterface::AUTHENTICATED_ROLE :: string (13) "authenticated"
- ⇄Drupal\Core\Entity\FieldableEntityInterface Iterator Contents uninitialized Blacklistediterator_to_array($0['#user'], false)
- ⇄Drupal\Core\Entity\FieldableEntityInterface Iterator Contents uninitialized Blacklisted
- #view_mode => string (4) "full"$0['#view_mode']
- #cache => array (5)$0['#cache']
- tags => array (2)$0['#cache']['tags']
- 0 => string (9) "user_view"$0['#cache']['tags'][0]
- 1 => string (9) "user:6398"$0['#cache']['tags'][1]
- 0 => string (9) "user_view"
- contexts => array (1)$0['#cache']['contexts']
- 0 => string (31) "route.name.is_layout_builder_ui"$0['#cache']['contexts'][0]
- 0 => string (31) "route.name.is_layout_builder_ui"
- max-age => integer -1$0['#cache']['max-age']
- keys => array (4)$0['#cache']['keys']
- 0 => string (11) "entity_view"$0['#cache']['keys'][0]
- 1 => string (4) "user"$0['#cache']['keys'][1]
- 2 => string (4) "6398"$0['#cache']['keys'][2]
- 3 => string (4) "full"$0['#cache']['keys'][3]
- 0 => string (11) "entity_view"
- bin => string (6) "render"$0['#cache']['bin']
- tags => array (2)
- #theme => string (4) "user"$0['#theme']
- #weight => integer 0$0['#weight']
- #pre_render => array (1)$0['#pre_render']
- 0 => array (2)$0['#pre_render'][0]
- 0 => Drupal\Core\Entity\EntityViewBuilder#1684 (12)$0['#pre_render'][0][0]
- Properties (12)
- Methods (24)
- Static methods (2)
- Class constants (3)
- protected moduleHandler -> Drupal\Core\Extension\ModuleHandler#30 Blacklisted
- protected stringTranslation -> Drupal\Core\StringTranslation\TranslationManager#312 Depth Limit
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected entityTypeId -> string (4) "user"
- protected entityType -> Drupal\Core\Entity\ContentEntityType#805 Depth Limit
- protected entityRepository -> Drupal\Core\Entity\EntityRepository#469 Depth Limit
- protected entityDisplayRepository -> Drupal\Core\Entity\EntityDisplayRepository#880 Depth Limit
- protected cacheBin -> string (6) "render"
- protected languageManager -> Drupal\Core\Language\LanguageManager#337 Depth Limit
- protected themeRegistry -> Drupal\Core\Theme\Registry#392 Depth Limit
- protected singleFieldDisplays -> null
- public __construct(Drupal\Core\Entity\EntityTypeInterface $entity_type, Drupal\Core\Entity\EntityRepositoryInterface $entity_repository, Drupal\Core\Language\LanguageManagerInterface $language_manager, Drupal\Core\Theme\Registry $theme_registry, Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository) Constructs a new EntityViewBuilder.new \Drupal\Core\Entity\EntityViewBuilder()
/** * Constructs a new EntityViewBuilder. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type definition. * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository * The entity repository service. * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager * The language manager. * @param \Drupal\Core\Theme\Registry $theme_registry * The theme registry. * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository * The entity display repository. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:97
- public view(Drupal\Core\Entity\EntityInterface $entity, $view_mode = 'full', $langcode = null) {@inheritdoc}$0['#pre_render'][0][0]->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:122
- public viewMultiple(array $entities = array(), $view_mode = 'full', $langcode = null) {@inheritdoc}$0['#pre_render'][0][0]->viewMultiple()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:145
- protected getBuildDefaults(Drupal\Core\Entity\EntityInterface $entity, $view_mode): array Provides entity-specific defaults to the build process.
/** * Provides entity-specific defaults to the build process. * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity for which the defaults should be provided. * @param string $view_mode * The view mode that should be used. * * @return array */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:177
- public build(array $build): array Builds an entity's view; augments entity defaults.$0['#pre_render'][0][0]->build()
/** * Builds an entity's view; augments entity defaults. * * This function is assigned as a #pre_render callback in ::view(). * * It transforms the renderable array for a single entity to the same * structure as if we were rendering multiple entities, and then calls the * default ::buildMultiple() #pre_render callback. * * @param array $build * A renderable array containing build information and context for an entity * view. * * @return array * The updated renderable array. * * @see \Drupal\Core\Render\RendererInterface::render() */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:237
- public buildMultiple(array $build_list): array Builds multiple entities' views; augments entity defaults.$0['#pre_render'][0][0]->buildMultiple()
/** * Builds multiple entities' views; augments entity defaults. * * This function is assigned as a #pre_render callback in ::viewMultiple(). * * By delaying the building of an entity until the #pre_render processing in * \Drupal::service('renderer')->render(), the processing cost of assembling * an entity's renderable array is saved on cache-hit requests. * * @param array $build_list * A renderable array containing build information and context for an * entity view. * * @return array * The updated renderable array. * * @see \Drupal\Core\Render\RendererInterface::render() */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:261
- public buildComponents(array &$build, array $entities, array $displays, $view_mode) {@inheritdoc}$0['#pre_render'][0][0]->buildComponents()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:315
- protected addContextualLinks(array &$build, Drupal\Core\Entity\EntityInterface $entity) Add contextual links.
/** * Add contextual links. * * @param array $build * The render array that is being created. * @param \Drupal\Core\Entity\EntityInterface $entity * The entity to be prepared. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:355
- protected alterBuild(array &$build, Drupal\Core\Entity\EntityInterface $entity, Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode) Specific per-entity building.
/** * Specific per-entity building. * * @param array $build * The render array that is being created. * @param \Drupal\Core\Entity\EntityInterface $entity * The entity to be prepared. * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity view display holding the display options configured for the * entity components. * @param string $view_mode * The view mode that should be used to prepare the entity. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:390
- public getCacheTags() {@inheritdoc}$0['#pre_render'][0][0]->getCacheTags()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:395
- public resetCache(?array $entities = null) {@inheritdoc}$0['#pre_render'][0][0]->resetCache()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:402
- protected isViewModeCacheable($view_mode): bool Determines whether the view mode is cacheable.
/** * Determines whether the view mode is cacheable. * * @param string $view_mode * Name of the view mode that should be rendered. * * @return bool * TRUE if the view mode can be cached, FALSE otherwise. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:435
- public viewField(Drupal\Core\Field\FieldItemListInterface $items, $display_options = array()) {@inheritdoc}$0['#pre_render'][0][0]->viewField()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:447
- public viewFieldItem(Drupal\Core\Field\FieldItemInterface $item, $display = array()) {@inheritdoc}$0['#pre_render'][0][0]->viewFieldItem()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:472
- protected getSingleFieldDisplay($entity, $field_name, $display_options): \Drupal\Core\Entity\Display\EntityViewDisplayInterface Gets an EntityViewDisplay for rendering an individual field.
/** * Gets an EntityViewDisplay for rendering an individual field. * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity. * @param string $field_name * The field name. * @param string|array $display_options * The display options passed to the viewField() method. * * @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:505
- protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Gets the module handler.
/** * Gets the module handler. * * @return \Drupal\Core\Extension\ModuleHandlerInterface * The module handler. */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:31
- public setModuleHandler(Drupal\Core\Extension\ModuleHandlerInterface $module_handler): $this Sets the module handler for this handler.$0['#pre_render'][0][0]->setModuleHandler()
/** * Sets the module handler for this handler. * * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler * The module handler. * * @return $this */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:46
- protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/** * Translates a string to the current language or to a given language. * * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for * important security information and usage guidelines. * * In order for strings to be localized, make them available in one of the * ways supported by the * @link https://www.drupal.org/node/322729 Localization API @endlink. When * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait * $this->t(). Otherwise create a new * \Drupal\Core\StringTranslation\TranslatableMarkup object. * * @param string $string * A string containing the English text to translate. * @param array $args * (optional) An associative array of replacements to make after * translation. Based on the first character of the key, the value is * escaped and/or themed. See * \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for * details. * @param array $options * (optional) An associative array of additional options, with the following * elements: * - 'langcode' (defaults to the current language): A language code, to * translate to a language other than what is used to display the page. * - 'context' (defaults to the empty context): The context the source * string belongs to. See the * @link i18n Internationalization topic @endlink for more information * about string contexts. * * @return \Drupal\Core\StringTranslation\TranslatableMarkup * An object that, when cast to a string, returns the translated string. * * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat() * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() * * @ingroup sanitization */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
- protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) Formats a string containing a count of items.
/** * Formats a string containing a count of items. * * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural() */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:79
- protected getNumberOfPlurals($langcode = null) Returns the number of plurals supported by a given language.
/** * Returns the number of plurals supported by a given language. * * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals() */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:88
- protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/** * Gets the string translation service. * * @return \Drupal\Core\StringTranslation\TranslationInterface * The string translation service. */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:102
- public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.$0['#pre_render'][0][0]->setStringTranslation()
/** * Sets the string translation service to use. * * @param \Drupal\Core\StringTranslation\TranslationInterface $translation * The string translation service. * * @return $this */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:118
- public __sleep() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
- public __wakeup() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityHandlerBase Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:74
- public __construct(Drupal\Core\Entity\EntityTypeInterface $entity_type, Drupal\Core\Entity\EntityRepositoryInterface $entity_repository, Drupal\Core\Language\LanguageManagerInterface $language_manager, Drupal\Core\Theme\Registry $theme_registry, Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository) Constructs a new EntityViewBuilder.
- public static Drupal\Core\Entity\EntityViewBuilder::createInstance(Symfony\Component\DependencyInjection\ContainerInterface $container, Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:109
- public static Drupal\Core\Entity\EntityViewBuilder::trustedCallbacks() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:138
- public const Drupal\Core\Security\TrustedCallbackInterface::THROW_EXCEPTION :: string (9) "exception"
- public const Drupal\Core\Security\TrustedCallbackInterface::TRIGGER_WARNING :: string (7) "warning"
- public const Drupal\Core\Security\TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION :: string (20) "silenced_deprecation"
- 1 => string (5) "build"$0['#pre_render'][0][1]
- 0 => Drupal\Core\Entity\EntityViewBuilder#1684 (12)
- 0 => array (2)
- #user => Drupal\user\Entity\User#1282 (29)