01 Version Original 1

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

/**
 * {@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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790

/**
 * 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

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

/**
 * {@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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790

/**
 * 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

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

/**
 * {@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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790

/**
 * 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

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

/**
 * {@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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:560

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:575

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:598

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:605

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:613

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:623

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:663

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:690

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:698

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:705

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:732

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:739

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:746

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:759

/**
 * 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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:779

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:790

/**
 * 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

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:833

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

/**
 * 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

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

/**
 * 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

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * {@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

/**
 * 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

/**
 * 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

/**
 * 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

/**
 * 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