123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899 |
- <?php
- namespace Drupal\Core\Field;
- use Drupal\Core\Cache\UnchangingCacheableDependencyTrait;
- use Drupal\Core\Entity\FieldableEntityInterface;
- use Drupal\Core\Field\Entity\BaseFieldOverride;
- use Drupal\Core\Field\TypedData\FieldItemDataDefinition;
- use Drupal\Core\TypedData\ListDataDefinition;
- use Drupal\Core\TypedData\OptionsProviderInterface;
- /**
- * A class for defining entity fields.
- */
- class BaseFieldDefinition extends ListDataDefinition implements FieldDefinitionInterface, FieldStorageDefinitionInterface, RequiredFieldStorageDefinitionInterface {
- use UnchangingCacheableDependencyTrait;
- /**
- * The field type.
- *
- * @var string
- */
- protected $type;
- /**
- * An array of field property definitions.
- *
- * @var \Drupal\Core\TypedData\DataDefinitionInterface[]
- *
- * @see \Drupal\Core\TypedData\ComplexDataDefinitionInterface::getPropertyDefinitions()
- */
- protected $propertyDefinitions;
- /**
- * The field schema.
- *
- * @var array
- */
- protected $schema;
- /**
- * @var array
- */
- protected $indexes = [];
- /**
- * Creates a new field definition.
- *
- * @param string $type
- * The type of the field.
- *
- * @return static
- * A new field definition object.
- */
- public static function create($type) {
- $field_definition = new static([]);
- $field_definition->type = $type;
- $field_definition->itemDefinition = FieldItemDataDefinition::create($field_definition);
- // Create a definition for the items, and initialize it with the default
- // settings for the field type.
- $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
- $default_settings = $field_type_manager->getDefaultStorageSettings($type) + $field_type_manager->getDefaultFieldSettings($type);
- $field_definition->itemDefinition->setSettings($default_settings);
- return $field_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
- */
- public static function createFromFieldStorageDefinition(FieldStorageDefinitionInterface $definition) {
- return static::create($definition->getType())
- ->setCardinality($definition->getCardinality())
- ->setConstraints($definition->getConstraints())
- ->setCustomStorage($definition->hasCustomStorage())
- ->setDescription($definition->getDescription())
- ->setLabel($definition->getLabel())
- ->setName($definition->getName())
- ->setProvider($definition->getProvider())
- ->setRevisionable($definition->isRevisionable())
- ->setSettings($definition->getSettings())
- ->setTargetEntityTypeId($definition->getTargetEntityTypeId())
- ->setTranslatable($definition->isTranslatable());
- }
- /**
- * {@inheritdoc}
- */
- public static function createFromItemType($item_type) {
- // The data type of a field item is in the form of "field_item:$field_type".
- $parts = explode(':', $item_type, 2);
- return static::create($parts[1]);
- }
- /**
- * {@inheritdoc}
- */
- public function getName() {
- return $this->definition['field_name'];
- }
- /**
- * Sets the field name.
- *
- * @param string $name
- * The field name to set.
- *
- * @return static
- * The object itself for chaining.
- */
- public function setName($name) {
- $this->definition['field_name'] = $name;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getType() {
- return $this->type;
- }
- /**
- * {@inheritdoc}
- */
- public function getSettings() {
- return $this->getItemDefinition()->getSettings();
- }
- /**
- * {@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.
- */
- public function setSettings(array $settings) {
- // Assign settings individually, in order to keep the current values
- // of settings not specified in $settings.
- foreach ($settings as $setting_name => $setting) {
- $this->getItemDefinition()->setSetting($setting_name, $setting);
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getSetting($setting_name) {
- return $this->getItemDefinition()->getSetting($setting_name);
- }
- /**
- * {@inheritdoc}
- */
- public function setSetting($setting_name, $value) {
- $this->getItemDefinition()->setSetting($setting_name, $value);
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getProvider() {
- return isset($this->definition['provider']) ? $this->definition['provider'] : NULL;
- }
- /**
- * Sets the name of the provider of this field.
- *
- * @param string $provider
- * The provider name to set.
- *
- * @return $this
- */
- public function setProvider($provider) {
- $this->definition['provider'] = $provider;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function isTranslatable() {
- return !empty($this->definition['translatable']);
- }
- /**
- * Sets whether the field is translatable.
- *
- * @param bool $translatable
- * Whether the field is translatable.
- *
- * @return $this
- * The object itself for chaining.
- */
- public function setTranslatable($translatable) {
- $this->definition['translatable'] = $translatable;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function isRevisionable() {
- return !empty($this->definition['revisionable']);
- }
- /**
- * Sets whether the field is revisionable.
- *
- * @param bool $revisionable
- * Whether the field is revisionable.
- *
- * @return $this
- * The object itself for chaining.
- */
- public function setRevisionable($revisionable) {
- $this->definition['revisionable'] = $revisionable;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getCardinality() {
- // @todo: Allow to control this.
- return isset($this->definition['cardinality']) ? $this->definition['cardinality'] : 1;
- }
- /**
- * Sets the maximum number of items allowed for the field.
- *
- * Possible values are positive integers or
- * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
- *
- * @param int $cardinality
- * The field cardinality.
- *
- * @return $this
- */
- public function setCardinality($cardinality) {
- $this->definition['cardinality'] = $cardinality;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function isMultiple() {
- $cardinality = $this->getCardinality();
- return ($cardinality == static::CARDINALITY_UNLIMITED) || ($cardinality > 1);
- }
- /**
- * {@inheritdoc}
- */
- public function isQueryable() {
- @trigger_error('BaseFieldDefinition::isQueryable() is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, you should use \Drupal\Core\Field\BaseFieldDefinition::hasCustomStorage(). See https://www.drupal.org/node/2856563.', E_USER_DEPRECATED);
- return !$this->hasCustomStorage();
- }
- /**
- * Sets whether the field is queryable.
- *
- * @param bool $queryable
- * Whether the field is queryable.
- *
- * @return static
- * The object itself for chaining.
- *
- * @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use
- * \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead.
- *
- * @see https://www.drupal.org/node/2856563
- */
- public function setQueryable($queryable) {
- @trigger_error('BaseFieldDefinition::setQueryable() is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, you should use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage(). See https://www.drupal.org/node/2856563.', E_USER_DEPRECATED);
- $this->definition['queryable'] = $queryable;
- return $this;
- }
- /**
- * 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.
- */
- public function setPropertyConstraints($name, array $constraints) {
- $item_constraints = $this->getItemDefinition()->getConstraints();
- $item_constraints['ComplexData'][$name] = $constraints;
- $this->getItemDefinition()->setConstraints($item_constraints);
- return $this;
- }
- /**
- * 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()
- */
- public function addPropertyConstraints($name, array $constraints) {
- $item_constraints = $this->getItemDefinition()->getConstraint('ComplexData') ?: [];
- if (isset($item_constraints[$name])) {
- // Add the new property constraints, overwriting as required.
- $item_constraints[$name] = $constraints + $item_constraints[$name];
- }
- else {
- $item_constraints[$name] = $constraints;
- }
- $this->getItemDefinition()->addConstraint('ComplexData', $item_constraints);
- return $this;
- }
- /**
- * 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 'type' = '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.
- */
- public function setDisplayOptions($display_context, array $options) {
- $this->definition['display'][$display_context]['options'] = $options;
- return $this;
- }
- /**
- * 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.
- */
- public function setDisplayConfigurable($display_context, $configurable) {
- // If no explicit display options have been specified, default to 'hidden'.
- if (empty($this->definition['display'][$display_context])) {
- $this->definition['display'][$display_context]['options'] = ['region' => 'hidden'];
- }
- $this->definition['display'][$display_context]['configurable'] = $configurable;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getDisplayOptions($display_context) {
- return isset($this->definition['display'][$display_context]['options']) ? $this->definition['display'][$display_context]['options'] : NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function isDisplayConfigurable($display_context) {
- return isset($this->definition['display'][$display_context]['configurable']) ? $this->definition['display'][$display_context]['configurable'] : FALSE;
- }
- /**
- * {@inheritdoc}
- */
- public function getDefaultValueLiteral() {
- return isset($this->definition['default_value']) ? $this->definition['default_value'] : [];
- }
- /**
- * {@inheritdoc}
- */
- public function getDefaultValueCallback() {
- return isset($this->definition['default_value_callback']) ? $this->definition['default_value_callback'] : NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function getDefaultValue(FieldableEntityInterface $entity) {
- // Allow custom default values function.
- if ($callback = $this->getDefaultValueCallback()) {
- $value = call_user_func($callback, $entity, $this);
- }
- else {
- $value = $this->getDefaultValueLiteral();
- }
- // Normalize into the "array keyed by delta" format.
- if (isset($value) && !is_array($value)) {
- $properties = $this->getPropertyNames();
- $property = reset($properties);
- $value = [
- [$property => $value],
- ];
- }
- // Allow the field type to process default values.
- $field_item_list_class = $this->getClass();
- return $field_item_list_class::processDefaultValue($value, $entity, $this);
- }
- /**
- * {@inheritdoc}
- */
- public function setDefaultValue($value) {
- if ($value === NULL) {
- $value = [];
- }
- // Unless the value is an empty array, we may need to transform it.
- if (!is_array($value) || !empty($value)) {
- if (!is_array($value)) {
- $value = [[$this->getMainPropertyName() => $value]];
- }
- elseif (is_array($value) && !is_numeric(array_keys($value)[0])) {
- $value = [0 => $value];
- }
- }
- $this->definition['default_value'] = $value;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setDefaultValueCallback($callback) {
- if (isset($callback) && !is_string($callback)) {
- throw new \InvalidArgumentException('Default value callback must be a string, like "function_name" or "ClassName::methodName"');
- }
- $this->definition['default_value_callback'] = $callback;
- return $this;
- }
- /**
- * 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).
- */
- public function getInitialValue() {
- $value = isset($this->definition['initial_value']) ? $this->definition['initial_value'] : [];
- // Normalize into the "array keyed by delta" format.
- if (isset($value) && !is_array($value)) {
- $value = [
- [$this->getMainPropertyName() => $value],
- ];
- }
- return $value;
- }
- /**
- * 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
- */
- public function setInitialValue($value) {
- // @todo Implement initial value support for multi-value fields in
- // https://www.drupal.org/node/2883851.
- if ($this->isMultiple()) {
- throw new FieldException('Multi-value fields can not have an initial value.');
- }
- if ($value === NULL) {
- $value = [];
- }
- // Unless the value is an empty array, we may need to transform it.
- if (!is_array($value) || !empty($value)) {
- if (!is_array($value)) {
- $value = [[$this->getMainPropertyName() => $value]];
- }
- elseif (is_array($value) && !is_numeric(array_keys($value)[0])) {
- $value = [0 => $value];
- }
- }
- $this->definition['initial_value'] = $value;
- return $this;
- }
- /**
- * Returns the name of the field that will be used for getting initial values.
- *
- * @return string|null
- * The field name.
- */
- public function getInitialValueFromField() {
- return isset($this->definition['initial_value_from_field']) ? $this->definition['initial_value_from_field'] : NULL;
- }
- /**
- * 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.
- *
- * @return $this
- */
- public function setInitialValueFromField($field_name) {
- $this->definition['initial_value_from_field'] = $field_name;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getOptionsProvider($property_name, FieldableEntityInterface $entity) {
- // If the field item class implements the interface, create an orphaned
- // runtime item object, so that it can be used as the options provider
- // without modifying the entity being worked on.
- if (is_subclass_of($this->getItemDefinition()->getClass(), OptionsProviderInterface::class)) {
- $items = $entity->get($this->getName());
- return \Drupal::service('plugin.manager.field.field_type')->createFieldItem($items, 0);
- }
- // @todo: Allow setting custom options provider, see
- // https://www.drupal.org/node/2002138.
- }
- /**
- * {@inheritdoc}
- */
- public function getPropertyDefinition($name) {
- if (!isset($this->propertyDefinitions)) {
- $this->getPropertyDefinitions();
- }
- if (isset($this->propertyDefinitions[$name])) {
- return $this->propertyDefinitions[$name];
- }
- }
- /**
- * {@inheritdoc}
- */
- public function getPropertyDefinitions() {
- if (!isset($this->propertyDefinitions)) {
- $class = $this->getItemDefinition()->getClass();
- $this->propertyDefinitions = $class::propertyDefinitions($this);
- }
- return $this->propertyDefinitions;
- }
- /**
- * {@inheritdoc}
- */
- public function getPropertyNames() {
- return array_keys($this->getPropertyDefinitions());
- }
- /**
- * {@inheritdoc}
- */
- public function getMainPropertyName() {
- $class = $this->getItemDefinition()->getClass();
- return $class::mainPropertyName();
- }
- /**
- * Helper to retrieve the field item class.
- *
- * @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use
- * \Drupal\Core\TypedData\ListDataDefinition::getClass() instead.
- */
- protected function getFieldItemClass() {
- @trigger_error('BaseFieldDefinition::getFieldItemClass() is deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Instead, you should use \Drupal\Core\TypedData\ListDataDefinition::getClass(). See https://www.drupal.org/node/2933964.', E_USER_DEPRECATED);
- if ($class = $this->getItemDefinition()->getClass()) {
- return $class;
- }
- else {
- $type_definition = \Drupal::typedDataManager()
- ->getDefinition($this->getItemDefinition()->getDataType());
- return $type_definition['class'];
- }
- }
- /**
- * {@inheritdoc}
- */
- public function __sleep() {
- // Do not serialize the statically cached property definitions.
- $vars = get_object_vars($this);
- unset($vars['propertyDefinitions'], $vars['typedDataManager']);
- return array_keys($vars);
- }
- /**
- * {@inheritdoc}
- */
- public function getTargetEntityTypeId() {
- return isset($this->definition['entity_type']) ? $this->definition['entity_type'] : NULL;
- }
- /**
- * 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
- */
- public function setTargetEntityTypeId($entity_type_id) {
- $this->definition['entity_type'] = $entity_type_id;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getTargetBundle() {
- return isset($this->definition['bundle']) ? $this->definition['bundle'] : NULL;
- }
- /**
- * 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
- */
- public function setTargetBundle($bundle) {
- $this->definition['bundle'] = $bundle;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getSchema() {
- if (!isset($this->schema)) {
- // Get the schema from the field item class.
- $definition = \Drupal::service('plugin.manager.field.field_type')->getDefinition($this->getType());
- $class = $definition['class'];
- $schema = $class::schema($this);
- // Fill in default values.
- $schema += [
- 'columns' => [],
- 'unique keys' => [],
- 'indexes' => [],
- 'foreign keys' => [],
- ];
- // Merge custom indexes with those specified by the field type. Custom
- // indexes prevail.
- $schema['indexes'] = $this->indexes + $schema['indexes'];
- $this->schema = $schema;
- }
- return $this->schema;
- }
- /**
- * {@inheritdoc}
- */
- public function getColumns() {
- $schema = $this->getSchema();
- // A typical use case for the method is to iterate on the columns, while
- // some other use cases rely on identifying the first column with the key()
- // function. Since the schema is persisted in the Field object, we take care
- // of resetting the array pointer so that the former does not interfere with
- // the latter.
- reset($schema['columns']);
- return $schema['columns'];
- }
- /**
- * {@inheritdoc}
- */
- public function hasCustomStorage() {
- return !empty($this->definition['custom_storage']) || $this->isComputed();
- }
- /**
- * {@inheritdoc}
- */
- public function isBaseField() {
- return TRUE;
- }
- /**
- * 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.
- */
- public function setCustomStorage($custom_storage) {
- if (!$custom_storage && $this->isComputed()) {
- throw new \LogicException("Entity storage cannot store a computed field.");
- }
- $this->definition['custom_storage'] = $custom_storage;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getFieldStorageDefinition() {
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getUniqueStorageIdentifier() {
- return $this->getTargetEntityTypeId() . '-' . $this->getName();
- }
- /**
- * {@inheritdoc}
- */
- public function getUniqueIdentifier() {
- // If we have a specified target bundle, we're dealing with a bundle base
- // field definition, so we need to include it in the unique identifier.
- if ($this->getTargetBundle()) {
- return $this->getTargetEntityTypeId() . '-' . $this->getTargetBundle() . '-' . $this->getName();
- }
- return $this->getUniqueStorageIdentifier();
- }
- /**
- * {@inheritdoc}
- */
- public function isDeleted() {
- return !empty($this->definition['deleted']);
- }
- /**
- * Sets whether the field storage is deleted.
- *
- * @param bool $deleted
- * Whether the field storage is deleted.
- *
- * @return $this
- */
- public function setDeleted($deleted) {
- $this->definition['deleted'] = $deleted;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getConfig($bundle) {
- $override = BaseFieldOverride::loadByName($this->getTargetEntityTypeId(), $bundle, $this->getName());
- if ($override) {
- return $override;
- }
- return BaseFieldOverride::createFromBaseFieldDefinition($this, $bundle);
- }
- /**
- * {@inheritdoc}
- */
- public function isStorageRequired() {
- if (isset($this->definition['storage_required'])) {
- return (bool) $this->definition['storage_required'];
- }
- // Default to the 'required' property of the base field.
- return $this->isRequired();
- }
- /**
- * Sets whether the field storage is required.
- *
- * @param bool $required
- * Whether the field storage is required.
- *
- * @return static
- * The object itself for chaining.
- */
- public function setStorageRequired($required) {
- $this->definition['storage_required'] = $required;
- return $this;
- }
- /**
- * Magic method: Implements a deep clone.
- */
- public function __clone() {
- parent::__clone();
- // The itemDefinition (\Drupal\Core\Field\TypedData\FieldItemDataDefinition)
- // has a property fieldDefinition, which is a recursive reference to the
- // parent BaseFieldDefinition, therefore the reference to the old object has
- // to be overwritten with a reference to the cloned one.
- $this->itemDefinition->setFieldDefinition($this);
- // Reset the static cache of the field property definitions in order to
- // ensure that the clone will reference different field property definitions
- // objects.
- $this->propertyDefinitions = NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function isInternal() {
- // All fields are not internal unless explicitly set.
- return !empty($this->definition['internal']);
- }
- }
|