/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
protected type -> string (11) "string_long"
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->revision_log->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->revision_log->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->revision_log->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->revision_log->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->revision_log->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->revision_log->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->revision_log->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->revision_log->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->revision_log->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->revision_log->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->revision_log->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->revision_log->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->revision_log->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->revision_log->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log
/**
* 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\FieldItemList()
/**
* 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->revision_log->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->revision_log->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->revision_log->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->revision_log->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->revision_log->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->revision_log->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->revision_log->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->revision_log->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->revision_log->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->revision_log->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->revision_log->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->revision_log->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:25
protected getModerationStateId(): string|null Gets the moderation state ID linked to a content entity revision.
/**
* Gets the moderation state ID linked to a content entity revision.
*
* @return string|null
* The moderation state ID linked to a content entity revision.
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:42
protected loadContentModerationStateRevision(Drupal\Core\Entity\ContentEntityInterface $entity): \Drupal\content_moderation\Entity\ContentModerationStateInterface|null Load the content moderation state revision associated with an entity.
/**
* Load the content moderation state revision associated with an entity.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The entity the content moderation state entity will be loaded from.
*
* @return \Drupal\content_moderation\Entity\ContentModerationStateInterface|null
* The content_moderation_state revision or FALSE if none exists.
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:73
public get($index) {@inheritdoc}
$0->moderation_state->get()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:110
public onChange($delta) {@inheritdoc}
$0->moderation_state->onChange()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:120
public setValue($values, $notify = true) {@inheritdoc}
$0->moderation_state->setValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:129
protected updateModeratedEntity($moderation_state_id) Updates the default revision flag and the publishing status of the entity.
/**
* Updates the default revision flag and the publishing status of the entity.
*
* @param string $moderation_state_id
* The ID of the new moderation state.
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:147
public generateSampleItems($count = 1) {@inheritdoc}
$0->moderation_state->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/content_moderation/src/Plugin/Field/ModerationStateFieldItemList.php:181
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->moderation_state->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->moderation_state->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:148
public preSave() {@inheritdoc}
$0->moderation_state->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->moderation_state->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->moderation_state->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->moderation_state->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->moderation_state->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public getConstraints() {@inheritdoc}
$0->moderation_state->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->moderation_state->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->moderation_state->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->moderation_state->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->moderation_state->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->moderation_state->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->moderation_state->getValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
public getString() {@inheritdoc}
$0->moderation_state->getString()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
public set($index, $value) {@inheritdoc}
$0->moderation_state->set()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
public removeItem($index) {@inheritdoc}
$0->moderation_state->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->moderation_state->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->moderation_state->offsetExists()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:122
public offsetUnset($offset) {@inheritdoc}
$0->moderation_state->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->moderation_state->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->moderation_state->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->moderation_state->appendItem()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
public getItemDefinition() {@inheritdoc}
$0->moderation_state->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->moderation_state->getIterator()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:131
public count() {@inheritdoc}
$0->moderation_state->count()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:140
public isEmpty() {@inheritdoc}
$0->moderation_state->isEmpty()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
public filter($callback) {@inheritdoc}
$0->moderation_state->filter()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:273
public __clone() Magic method: Implements a deep clone.
clone $0->moderation_state
/**
* 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\content_moderation\Plugin\Field\ModerationStateFieldItemList()
/**
* 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->moderation_state->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->moderation_state->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->moderation_state->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->moderation_state->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->moderation_state->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->moderation_state->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->moderation_state->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->moderation_state->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->moderation_state->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->moderation_state->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->moderation_state->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->moderation_state->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>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32
public traitGet($index) {@inheritdoc}
$0->moderation_state->traitGet()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9261 Depth Limit
/**
* {@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
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:26
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:33
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:26
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:33
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:26
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:33
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->metatag->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->metatag->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:148
public preSave() {@inheritdoc}
$0->metatag->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->metatag->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->metatag->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->metatag->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->metatag->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->metatag->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->metatag->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->metatag->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->metatag->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->metatag->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->metatag->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->metatag->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->metatag->getValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
public getString() {@inheritdoc}
$0->metatag->getString()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
public get($index) {@inheritdoc}
$0->metatag->get()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
public set($index, $value) {@inheritdoc}
$0->metatag->set()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
public removeItem($index) {@inheritdoc}
$0->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->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->metatag->offsetExists()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:122
public offsetUnset($offset) {@inheritdoc}
$0->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->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->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->metatag->appendItem()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
public getItemDefinition() {@inheritdoc}
$0->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->metatag->getIterator()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:131
public count() {@inheritdoc}
$0->metatag->count()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:140
public isEmpty() {@inheritdoc}
$0->metatag->isEmpty()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
public filter($callback) {@inheritdoc}
$0->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->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->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->metatag->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->metatag->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->metatag->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->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->metatag->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->metatag->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->metatag->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->metatag->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->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->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->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->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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
protected type -> string (4) "path"
protected propertyDefinitions -> array (4)
alias => Drupal\Core\TypedData\DataDefinition#9803 Depth Limit
/**
* {@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
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:30
public isEmpty() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:42
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathItem
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:57
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\pathauto\PathautoItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:17
public static Drupal\path\Plugin\Field\FieldType\PathItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:43
public static Drupal\path\Plugin\Field\FieldType\PathItem::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:110
public static Drupal\path\Plugin\Field\FieldType\PathItem::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:119
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public static Drupal\path\Plugin\Field\FieldType\PathItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:30
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* @{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->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->path->delete()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:57
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:40
public getEntity() {@inheritdoc}
$0->path->getEntity()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:47
public setLangcode($langcode) {@inheritdoc}
$0->path->setLangcode()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:56
public getLangcode() {@inheritdoc}
$0->path->getLangcode()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:63
public getFieldDefinition() {@inheritdoc}
$0->path->getFieldDefinition()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:70
public getSettings() {@inheritdoc}
$0->path->getSettings()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:77
public getSetting($setting_name) {@inheritdoc}
$0->path->getSetting()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:84
public filterEmptyItems() {@inheritdoc}
$0->path->filterEmptyItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:91
public setValue($values, $notify = true) {@inheritdoc}
$0->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}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:113
public __set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:123
public __isset($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:133
public __unset($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:143
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public applyDefaultValue($notify = true) {@inheritdoc}
$0->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->path->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->path->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public deleteRevision() {@inheritdoc}
$0->path->deleteRevision()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:212
public view($display_options = array()) {@inheritdoc}
$0->path->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->path->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->path->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->path->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->path->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->path->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->path->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->path->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->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->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->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->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->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->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->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->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->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->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->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->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->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->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->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->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->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->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->path->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->path->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->path->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->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->path->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->path->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->path->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->path->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->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->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->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->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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->rh_action->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->rh_action->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->rh_action->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->rh_action->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->rh_action->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->rh_action->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->rh_action->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->rh_action->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->rh_action->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->rh_action->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->rh_action->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->rh_action->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->rh_action->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->rh_action->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action->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->rh_action
/**
* 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\FieldItemList()
/**
* 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->rh_action->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->rh_action->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->rh_action->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->rh_action->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->rh_action->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->rh_action->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->rh_action->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->rh_action->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->rh_action->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->rh_action->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->rh_action->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->rh_action->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->rh_redirect->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->rh_redirect->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->rh_redirect->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->rh_redirect->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->rh_redirect->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->rh_redirect->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->rh_redirect->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->rh_redirect->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->rh_redirect->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->rh_redirect->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->rh_redirect->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->rh_redirect->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->rh_redirect->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->rh_redirect->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect
/**
* 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\FieldItemList()
/**
* 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->rh_redirect->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->rh_redirect->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->rh_redirect->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->rh_redirect->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->rh_redirect->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->rh_redirect->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->rh_redirect->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->rh_redirect->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->rh_redirect->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->rh_redirect->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->rh_redirect->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->rh_redirect->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
protected name -> string (20) "rh_redirect_response"
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->rh_redirect_response->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->rh_redirect_response->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->rh_redirect_response->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->rh_redirect_response->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->rh_redirect_response->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->rh_redirect_response->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->rh_redirect_response->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->rh_redirect_response->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->rh_redirect_response->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->rh_redirect_response->defaultValuesForm()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->rh_redirect_response->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->rh_redirect_response->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response
/**
* 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\FieldItemList()
/**
* 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->rh_redirect_response->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->rh_redirect_response->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->rh_redirect_response->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->rh_redirect_response->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->rh_redirect_response->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->rh_redirect_response->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->rh_redirect_response->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->rh_redirect_response->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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->rh_redirect_response->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
protected name -> string (27) "rh_redirect_fallback_action"
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->rh_redirect_fallback_action->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->rh_redirect_fallback_action->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->rh_redirect_fallback_action->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->rh_redirect_fallback_action->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->rh_redirect_fallback_action->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->rh_redirect_fallback_action->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->appendItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213
/**
* {@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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action->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->rh_redirect_fallback_action
/**
* 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\FieldItemList()
/**
* 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->rh_redirect_fallback_action->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->rh_redirect_fallback_action->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.
/**
* 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.
/**
* 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.
/**
* 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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->publish_on->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->publish_on->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->publish_on->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->publish_on->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->publish_on->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->publish_on->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->publish_on->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->publish_on->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->publish_on->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->publish_on->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->publish_on->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->publish_on->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->publish_on->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->publish_on->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on->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->publish_on
/**
* 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\FieldItemList()
/**
* 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->publish_on->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->publish_on->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->publish_on->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->publish_on->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->publish_on->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->publish_on->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->publish_on->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->publish_on->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->publish_on->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->publish_on->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->publish_on->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->publish_on->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->unpublish_on->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->unpublish_on->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->unpublish_on->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->unpublish_on->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->unpublish_on->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->unpublish_on->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->unpublish_on->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->unpublish_on->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->unpublish_on->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->unpublish_on->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->unpublish_on->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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->unpublish_on->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->unpublish_on->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->unpublish_on->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on
/**
* 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\FieldItemList()
/**
* 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->unpublish_on->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->unpublish_on->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->unpublish_on->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->unpublish_on->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->unpublish_on->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->unpublish_on->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->unpublish_on->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->unpublish_on->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->unpublish_on->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->unpublish_on->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->unpublish_on->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->unpublish_on->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/token/src/MenuLinkFieldItemList.php:20
public getConstraints() {@inheritdoc}
$0->menu_link->getConstraints()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
public referencedEntities() {@inheritdoc}
$0->menu_link->referencedEntities()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
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->menu_link->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->menu_link->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->menu_link->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:148
public preSave() {@inheritdoc}
$0->menu_link->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->menu_link->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->menu_link->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->menu_link->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->menu_link->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->menu_link->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->menu_link->defaultValuesForm()
/**
* {@inheritdoc}
*/
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->menu_link->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->menu_link->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->menu_link->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->menu_link->getValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
public getString() {@inheritdoc}
$0->menu_link->getString()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
public get($index) {@inheritdoc}
$0->menu_link->get()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
public set($index, $value) {@inheritdoc}
$0->menu_link->set()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
public removeItem($index) {@inheritdoc}
$0->menu_link->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->menu_link->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->menu_link->offsetExists()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:122
public offsetUnset($offset) {@inheritdoc}
$0->menu_link->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->menu_link->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->menu_link->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->menu_link->appendItem()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
public getItemDefinition() {@inheritdoc}
$0->menu_link->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->menu_link->getIterator()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:131
public count() {@inheritdoc}
$0->menu_link->count()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:140
public isEmpty() {@inheritdoc}
$0->menu_link->isEmpty()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
public filter($callback) {@inheritdoc}
$0->menu_link->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->menu_link->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->menu_link
/**
* 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\token\MenuLinkFieldItemList()
/**
* 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->menu_link->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->menu_link->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->menu_link->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->menu_link->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->menu_link->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->menu_link->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->menu_link->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->menu_link->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->menu_link->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->menu_link->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->menu_link->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->menu_link->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>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32
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
body -> Drupal\text\Plugin\Field\FieldType\TextFieldItemList#8484 (9)
$0->body
Field (3)
Properties (9)
Methods (68)
Static methods (2)
Iterator
value -> string (466) "<p>CounsellingBC was created to link you with professional counsellors in yo...
$0->body->value
<p>CounsellingBC was created to link you with professional counsellors in your local area and a wealth of mental health resources. If you're not sure where to start, visit our help page for instructions.</p><ol><li>We do not provide counselling services via this email contact.</li><li>We can not help you choose a particular counsellor via this <a href="/contact-us">contact form</a>, but if you have other questions related to the site please contact us.</li></ol>
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:87
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:95
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:119
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\text\Plugin\Field\FieldType\TextItemBase
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:99
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\text\Plugin\Field\FieldType\TextItemBase
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:116
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:33
public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:43
public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:62
public static Drupal\text\Plugin\Field\FieldType\TextItemBase::validateAllowedFormats(array &$element, Drupal\Core\Form\FormStateInterface $form_state) Render API callback: Processes the allowed formats value.
/**
* Render API callback: Processes the allowed formats value.
*
* Ensure the element's value is an indexed array of selected format IDs.
* This function is assigned as an #element_validate callback.
*
* @see static::fieldSettingsForm()
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:51
public static Drupal\text\Plugin\Field\FieldType\TextItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:59
public static Drupal\text\Plugin\Field\FieldType\TextItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:131
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public static Drupal\text\Plugin\Field\FieldType\TextItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:20
public static Drupal\text\Plugin\Field\FieldType\TextItemBase::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:76
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->body->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->body->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->body->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->body->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->body->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->body->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->body->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->body->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->body->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->body->defaultValuesForm()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->body->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->body->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->body->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body
/**
* 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\text\Plugin\Field\FieldType\TextFieldItemList()
/**
* 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->body->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->body->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->body->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->body->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->body->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->body->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->body->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->body->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->body->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->body->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->body->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->body->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 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 __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->field_hero_image->defaultValuesForm()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:16
public postSave($update) {@inheritdoc}
$0->field_hero_image->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:21
public delete() {@inheritdoc}
$0->field_hero_image->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:80
public deleteRevision() {@inheritdoc}
$0->field_hero_image->deleteRevision()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:95
public getConstraints() {@inheritdoc}
$0->field_hero_image->getConstraints()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
public referencedEntities() {@inheritdoc}
$0->field_hero_image->referencedEntities()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
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->field_hero_image->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\EntityReferenceFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->field_hero_image->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->field_hero_image->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->field_hero_image->preSave()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->field_hero_image->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->field_hero_image->generateSampleItems()
/**
* {@inheritdoc}
*/
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->field_hero_image->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->field_hero_image->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->field_hero_image->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image
/**
* 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->field_hero_image->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->field_hero_image->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->field_hero_image->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->field_hero_image->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->field_hero_image->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->field_hero_image->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->field_hero_image->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->field_hero_image->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->field_hero_image->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->field_hero_image->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->field_hero_image->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->field_hero_image->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 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
Reach out to us for any inquiries about counselling, psychological services, art therapy, and psychotherapy in BC. We're here to help!
{"description":"Reach out to us for any inquiries about counselling, psychological services, art therapy, and psychotherapy in BC. We\u0027re here to help!"}
public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
new \Drupal\layout_builder\Section()
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:65
public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:85
public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:115
public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:132
public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:145
public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:157
public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:168
public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:178
public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:194
protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:210
public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:223
public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:236
protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:251
public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:268
public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:291
public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:314
protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:343
public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:355
public __clone() Magic method: Implements a deep clone.
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:440
protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:450
public static Drupal\layout_builder\Section::fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:377
public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
new \Drupal\layout_builder\Section()
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:65
public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:85
public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:115
public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:132
public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:145
public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:157
public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:168
public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:178
public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:194
protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:210
public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:223
public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:236
protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:251
public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:268
public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:291
public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:314
protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:343
public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:355
public __clone() Magic method: Implements a deep clone.
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:440
protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:450
public static Drupal\layout_builder\Section::fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:377
public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
new \Drupal\layout_builder\Section()
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:65
public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:85
public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:115
public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:132
public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:145
public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:157
public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:168
public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:178
public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:194
protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:210
public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:223
public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:236
protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:251
public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:268
public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:291
public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:314
protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:343
public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:355
public __clone() Magic method: Implements a deep clone.
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:440
protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:450
public static Drupal\layout_builder\Section::fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <drupal>/core/modules/layout_builder/src/Section.php:377
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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) "layout_builder__layout"
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:35
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:59
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:66
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:83
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:35
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:59
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:66
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:83
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:116
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:131
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:163
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
public getIterator() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:188
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:215
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:232
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:242
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@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}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@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.
/**
* 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.
/**
* 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.
/**
* 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 static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:35
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:59
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:66
public static Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php:83
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public applyDefaultValue($notify = true) {@inheritdoc}
$0->layout_builder__layout->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public postSave($update) {@inheritdoc}
$0->layout_builder__layout->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->layout_builder__layout->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->layout_builder__layout->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->layout_builder__layout->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->layout_builder__layout->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->layout_builder__layout->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->layout_builder__layout->defaultValuesForm()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->layout_builder__layout->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->count()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:29
public isEmpty() {@inheritdoc}
$0->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout->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->layout_builder__layout
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:176
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\layout_builder\Field\LayoutSectionItemList()
/**
* 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->layout_builder__layout->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->layout_builder__layout->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->layout_builder__layout->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->layout_builder__layout->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->layout_builder__layout->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->layout_builder__layout->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->layout_builder__layout->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->layout_builder__layout->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->layout_builder__layout->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.
/**
* 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->layout_builder__layout->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->layout_builder__layout->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 getSection($delta) {@inheritdoc}
$0->layout_builder__layout->getSection()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:40
protected setSection($delta, Drupal\layout_builder\Section $section): $this Sets the section for the given delta on the display.
/**
* Sets the section for the given delta on the display.
*
* @param int $delta
* The delta of the section.
* @param \Drupal\layout_builder\Section $section
* The layout section.
*
* @return $this
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:58
public appendSection(Drupal\layout_builder\Section $section) {@inheritdoc}
$0->layout_builder__layout->appendSection()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:68
public insertSection($delta, Drupal\layout_builder\Section $section) {@inheritdoc}
$0->layout_builder__layout->insertSection()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:78
protected addBlankSection(): $this Adds a blank section to the list.
/**
* Adds a blank section to the list.
*
* @return $this
*
* @see \Drupal\layout_builder\Plugin\Layout\BlankLayout
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:103
protected hasBlankSection(): bool Indicates if this section list contains a blank section.
/**
* Indicates if this section list contains a blank section.
*
* A blank section is used to differentiate the difference between a layout
* that has never been instantiated and one that has purposefully had all
* sections removed.
*
* @return bool
* TRUE if the section list contains a blank section, FALSE otherwise.
*
* @see \Drupal\layout_builder\Plugin\Layout\BlankLayout
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:124
public removeSection($delta) {@inheritdoc}
$0->layout_builder__layout->removeSection()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:133
public removeAllSections($set_blank = false) {@inheritdoc}
$0->layout_builder__layout->removeAllSections()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:152
protected hasSection($delta): bool Indicates if there is a section at the specified delta.
/**
* Indicates if there is a section at the specified delta.
*
* @param int $delta
* The delta of the section.
*
* @return bool
* TRUE if there is a section for this delta, FALSE otherwise.
*/
Defined in <drupal>/core/modules/layout_builder/src/SectionListTrait.php:169
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 __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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 (21) "rabbit_hole__settings"
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:152
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0->rabbit_hole__settings->defaultAccess()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:160
public applyDefaultValue($notify = true) {@inheritdoc}
$0->rabbit_hole__settings->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:168
public preSave() {@inheritdoc}
$0->rabbit_hole__settings->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:187
public postSave($update) {@inheritdoc}
$0->rabbit_hole__settings->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:197
public delete() {@inheritdoc}
$0->rabbit_hole__settings->delete()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:205
public deleteRevision() {@inheritdoc}
$0->rabbit_hole__settings->deleteRevision()
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:227
public view($display_options = array()) {@inheritdoc}
$0->rabbit_hole__settings->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:241
public generateSampleItems($count = 1) {@inheritdoc}
$0->rabbit_hole__settings->generateSampleItems()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:249
public getConstraints() {@inheritdoc}
$0->rabbit_hole__settings->getConstraints()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:261
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0->rabbit_hole__settings->defaultValuesForm()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:282
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:344
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0->rabbit_hole__settings->equals()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:395
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0->rabbit_hole__settings->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:441
public getValue() {@inheritdoc}
$0->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings
/**
* 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\FieldItemList()
/**
* 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->rabbit_hole__settings->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0->rabbit_hole__settings->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0->rabbit_hole__settings->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0->rabbit_hole__settings->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->rabbit_hole__settings->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0->rabbit_hole__settings->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0->rabbit_hole__settings->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0->rabbit_hole__settings->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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->rabbit_hole__settings->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 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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
vid => Drupal\Core\Field\BaseFieldDefinition#1337 (7)
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
type => Drupal\Core\Field\BaseFieldDefinition#1343 (7)
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
protected type -> string (11) "string_long"
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#1357 (7)
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
title => Drupal\Core\Field\BaseFieldDefinition#1366 (7)
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
created => Drupal\Core\Field\BaseFieldDefinition#1369 (7)
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@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
public original -> uninitialized
public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/**
* Constructs a BaseFieldOverride object.
*
* In most cases, base field override entities are created via
* BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle')
*
* @param array $values
* An array of base field bundle override properties, keyed by property
* name. The field to override is specified by referring to an existing
* field with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the bundle field override is attached to. Other array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details.
* @param string $entity_type
* (optional) The type of the entity to create. Defaults to
* 'base_field_override'.
*
* @throws \Drupal\Core\Field\FieldException
* Exception thrown if $values does not contain a field_name, entity_type or
* bundle value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:102
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:119
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:126
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:133
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:147
public isInternal(): bool {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:154
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:161
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:168
protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/**
* Gets the base field definition.
*
* @return \Drupal\Core\Field\BaseFieldDefinition
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:177
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*
* @throws \Drupal\Core\Field\FieldException
* If the bundle is being changed.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:191
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:262
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 calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:236
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:263
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:276
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <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 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 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 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
/**
* 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
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.
/**
* Creates a base field override object.
*
* @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition
* The base field definition to override.
* @param string $bundle
* The bundle to which the override applies.
*
* @return \Drupal\Core\Field\Entity\BaseFieldOverride
* A new base field override object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:71
public static Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:226
public static Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.
/**
* Loads a base field bundle override config entity.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\Core\Field\FieldConfigInterface|null
* The base field bundle override config entity if one exists for the
* provided field name, otherwise NULL.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:255
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
/**
* {@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
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
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\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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 __sleep() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:372
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:382
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <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 static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
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
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
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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
public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/**
* Constructs a FieldStorageConfig object.
*
* In most cases, Field entities are created via
* FieldStorageConfig::create($values)), where $values is the same parameter
* as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. Most array
* elements will be used to set the corresponding properties on the class;
* see the class property documentation for details. Some array elements
* have special meanings and a few are required. Special elements are:
* - name: required. As a temporary Backwards Compatibility layer right now,
* a 'field_name' property can be accepted in place of 'id'.
* - entity_type: required.
* - type: required.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_storage_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:262
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:283
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:290
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\Entity::preSave().
/**
* Overrides \Drupal\Core\Entity\Entity::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:317
protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/**
* Prepares saving a new field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:347
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:373
protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/**
* Prepares saving an updated field definition.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:394
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:418
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:476
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:502
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:509
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:516
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:524
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:537
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:544
public getTypeProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:551
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:558
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:565
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:579
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:598
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:606
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:614
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:621
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:629
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:637
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:644
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:651
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:658
public setCardinality($cardinality) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:675
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:683
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:710
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:718
public setLocked($locked) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:725
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:733
public hasData(): bool Determines whether a field has any data.
/**
* Determines whether a field has any data.
*
* @return bool
* TRUE if the field has data for any entity; FALSE otherwise.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:743
public __sleep() Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:754
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:765
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:772
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:779
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:791
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:802
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:817
protected getFieldItemClass() Helper to retrieve the field item class.
/**
* Helper to retrieve the field item class.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
public isDeletable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
public getIndexes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:859
public setIndexes(array $indexes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
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
/**
* 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
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:475
/**
* {@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
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
/**
* {@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}
/**
* {@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
/**
* 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:432
public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:461
public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name
* Name of the field.
*
* @return \Drupal\field\FieldStorageConfigInterface|null
* The field config entity if one exists for the provided field name,
* otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:842
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
/**
* {@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
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
public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
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
/**
* 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
/**
* {@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
/**
* {@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
/**
* 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
/**
* {@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)
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#1333 (5)
Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)
protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#1476 (5)
Properties (5)
Methods (12)
Static methods (2)
toString
protected string -> string (13) "Not specified"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:267
name string (13) "Not specified"
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)
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#1477 (5)
Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)
protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#1478 (5)
Properties (5)
Methods (12)
Static methods (2)
toString
protected string -> string (14) "Not applicable"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep() Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
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.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:228
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:120
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and
* inserted via placeholders.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* Null args[] values are deprecated in Drupal 9.5 and will fail in
* Drupal 11.0. The value replaces the placeholder in $string. Sanitization
* and formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: When the placeholder replacement value is:
* - A string, the replaced value in the returned string will be sanitized
* using \Drupal\Component\Utility\Html::escape().
* - A MarkupInterface object, the replaced value in the returned string
* will not be sanitized.
* - A MarkupInterface object cast to a string, the replaced value in the
* returned string be forcibly sanitized using
* \Drupal\Component\Utility\Html::escape().
* @code
* $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object));
* @endcode
* Use this placeholder as the default choice for anything displayed on
* the site, but not within HTML attributes, JavaScript, or CSS. Doing so
* is a security risk.
* - %variable: Use when the replacement value is to be wrapped in <em>
* tags.
* A call like:
* @code
* $string = "%output_text";
* $arguments = ['%output_text' => 'text output here.'];
* $this->placeholderFormat($string, $arguments);
* @endcode
* makes the following HTML code:
* @code
* <em class="placeholder">text output here.</em>
* @endcode
* As with @variable, do not use this within HTML attributes, JavaScript,
* or CSS. Doing so is a security risk.
* - :variable: Return value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the attribute value is always
* wrapped in quotes:
* @code
* // Secure (with quotes):
* $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]);
* // Insecure (without quotes):
* $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]);
* @endcode
* When ":variable" comes from arbitrary user input, the result is secure,
* but not guaranteed to be a valid URL (which means the resulting output
* could fail HTML validation). To guarantee a valid URL, use
* Url::fromUri($user_input)->toString() (which either throws an exception
* or returns a well-formed URL) before passing the result into a
* ":variable" placeholder.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:196
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:267
name string (14) "Not applicable"
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)
/**
* {@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->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->setNewRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:303
public getLoadedRevisionId() {@inheritdoc}
$0->getLoadedRevisionId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:325
public updateLoadedRevisionId() {@inheritdoc}
$0->updateLoadedRevisionId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:332
public isNewRevision() {@inheritdoc}
$0->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->isDefaultRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:347
public wasDefaultRevision() {@inheritdoc}
$0->wasDefaultRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:360
public isLatestRevision() {@inheritdoc}
$0->isLatestRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:375
public isLatestTranslationAffectedRevision() {@inheritdoc}
$0->isLatestTranslationAffectedRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:385
public isRevisionTranslationAffected() {@inheritdoc}
$0->isRevisionTranslationAffected()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:395
public setRevisionTranslationAffected($affected) {@inheritdoc}
$0->setRevisionTranslationAffected()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:402
public isRevisionTranslationAffectedEnforced() {@inheritdoc}
$0->isRevisionTranslationAffectedEnforced()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:412
public setRevisionTranslationAffectedEnforced($enforced) {@inheritdoc}
$0->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->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->isDefaultTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:442
public getRevisionId() {@inheritdoc}
$0->getRevisionId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:452
public isTranslatable() {@inheritdoc}
$0->isTranslatable()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:459
public validate() {@inheritdoc}
$0->validate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:516
public isValidationRequired() {@inheritdoc}
$0->isValidationRequired()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:525
public setValidationRequired($required) {@inheritdoc}
$0->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->id()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:567
public bundle() {@inheritdoc}
$0->bundle()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:574
public uuid() {@inheritdoc}
$0->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->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->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->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->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->getTranslatableFields()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:677
public getIterator() {@inheritdoc}
$0->getIterator()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:691
public getFieldDefinition($name) {@inheritdoc}
$0->getFieldDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:698
public getFieldDefinitions() {@inheritdoc}
$0->getFieldDefinitions()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:710
public toArray() {@inheritdoc}
$0->toArray()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:720
public language() {@inheritdoc}
$0->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->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:811
public getTranslation($langcode) {@inheritdoc}
$0->getTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:877
public getUntranslated() {@inheritdoc}
$0->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->hasTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:963
public isNewTranslation() {@inheritdoc}
$0->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->addTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:980
public removeTranslation($langcode) {@inheritdoc}
$0->removeTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1001
public getTranslationStatus($langcode) {@inheritdoc}
$0->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->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->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->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
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1211
public label() {@inheritdoc}
$0->label()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1297
public referencedEntities() {@inheritdoc}
$0->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->hasTranslationChanges()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1446
public isDefaultTranslationAffectedOnly() {@inheritdoc}
$0->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 isNew() {@inheritdoc}
$0->isNew()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:120
public enforceIsNew($value = true) {@inheritdoc}
$0->enforceIsNew()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:127
public getEntityTypeId() {@inheritdoc}
$0->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->toUrl()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public hasLinkTemplate($rel) {@inheritdoc}
$0->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
/**
* {@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->uriRelationships()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:299
public save() {@inheritdoc}
$0->save()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:352
public delete() {@inheritdoc}
$0->delete()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:360
public getEntityType() {@inheritdoc}
$0->getEntityType()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:386
public getCacheContexts() {@inheritdoc}
$0->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->getCacheTagsToInvalidate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:472
public getCacheTags() {@inheritdoc}
$0->getCacheTags()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:482
public getCacheMaxAge() {@inheritdoc}
$0->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->getOriginalId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:574
public setOriginalId($id) {@inheritdoc}
$0->setOriginalId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
public getTypedData() {@inheritdoc}
$0->getTypedData()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:603
public getConfigDependencyKey() {@inheritdoc}
$0->getConfigDependencyKey()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:648
public getConfigDependencyName() {@inheritdoc}
$0->getConfigDependencyName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:655
public getConfigTarget() {@inheritdoc}
$0->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->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->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->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->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->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->setSyncing()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
$0->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->getChangedTimeAcrossTranslations()
/**
* Returns the timestamp of the last entity change across all translations.
*
* @return int
* The timestamp of the last entity save operation across all
* translations.
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <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->getChangedTime()
/**
* Gets the timestamp of the last entity change for the current translation.
*
* @return int|null
* The timestamp of the last entity save operation. Some entities allow a
* NULL value indicating the changed time is unknown.
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <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->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
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46
public isPublished() {@inheritdoc}
$0->isPublished()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:47
public setPublished() {@inheritdoc}
$0->setPublished()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:54
public setUnpublished() {@inheritdoc}
$0->setUnpublished()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:64
public getRevisionCreationTime() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
$0->getRevisionCreationTime()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:69
public setRevisionCreationTime($timestamp) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
$0->setRevisionCreationTime()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:76
public getRevisionUser() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
$0->getRevisionUser()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:84
public setRevisionUser(Drupal\user\UserInterface $account) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
$0->setRevisionUser()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:91
public getRevisionUserId() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
$0->getRevisionUserId()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:99
public setRevisionUserId($user_id) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
$0->setRevisionUserId()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:106
public getRevisionLogMessage() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
$0->getRevisionLogMessage()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:114
public setRevisionLogMessage($revision_log_message) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
$0->setRevisionLogMessage()
/**
* Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
*/
Inherited from Drupal\Core\Entity\EditorialContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:121
public getOwnerId() {@inheritdoc}
$0->getOwnerId()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:48
public setOwnerId($uid) {@inheritdoc}
$0->setOwnerId()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:55
public getOwner() {@inheritdoc}
$0->getOwner()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:65
public setOwner(Drupal\user\UserInterface $account) {@inheritdoc}
$0->setOwner()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:73
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\node\Entity\Node::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/node/src/Entity/Node.php:173
public static Drupal\node\Entity\Node::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $nodes) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/node/src/Entity/Node.php:189
public static Drupal\node\Entity\Node::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/node/src/Entity/Node.php:272
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::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\EditorialContentEntityBase::publishedBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for publishing status.
/**
* Returns an array of base field definitions for publishing status.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type to add the publishing status field to.
*
* @return \Drupal\Core\Field\BaseFieldDefinition[]
* An array of base field definitions.
*
* @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException
* Thrown when the entity type does not implement EntityPublishedInterface
* or if it does not have a "published" entity key.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:27
public static Drupal\Core\Entity\EditorialContentEntityBase::revisionLogBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\FieldDefinitionInterface[] Provides revision-related base field definitions for an entity type.
/**
* Provides revision-related base field definitions for an entity type.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
*
* @return \Drupal\Core\Field\FieldDefinitionInterface[]
* An array of base field definitions for the entity type, keyed by field
* name.
*
* @see \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:28
public static Drupal\node\Entity\Node::ownerBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for entity owners.
/**
* Returns an array of base field definitions for entity owners.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type to add the owner field to.
*
* @return \Drupal\Core\Field\BaseFieldDefinition[]
* An array of base field definitions.
*
* @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException
* Thrown when the entity type does not implement EntityOwnerInterface or
* if it does not have an "owner" entity key.
*/
Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:28
public static Drupal\node\Entity\Node::getDefaultEntityOwner(): mixed Default value callback for 'owner' base field.
/**
* Default value callback for 'owner' base field.
*
* @return mixed
* A default value for the owner field.
*/
Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:86
public static Drupal\Core\Entity\EditorialContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php:19
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::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\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::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:519