Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\Core\Field;
Chris@18: 
Chris@18: use Drupal\Core\Cache\UnchangingCacheableDependencyTrait;
Chris@18: use Drupal\Core\Entity\FieldableEntityInterface;
Chris@18: use Drupal\Core\Field\TypedData\FieldItemDataDefinition;
Chris@18: use Drupal\Core\TypedData\ListDataDefinition;
Chris@18: 
Chris@18: /**
Chris@18:  * A class for defining entity field definitions.
Chris@18:  *
Chris@18:  * A field definition in the context of a bundle field is different from a base
Chris@18:  * field in that it may exist only for one or more bundles of an entity type. A
Chris@18:  * bundle field definition may also override the definition of an existing base
Chris@18:  * field definition on a per bundle basis. The bundle field definition is used
Chris@18:  * for code driven overrides, while the
Chris@18:  * \Drupal\Core\Field\Entity\BaseFieldOverride uses config to override the base
Chris@18:  * field definition.
Chris@18:  *
Chris@18:  * Bundle fields can be defined in code using hook_entity_bundle_field_info() or
Chris@18:  * via the
Chris@18:  * \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions() method
Chris@18:  * when defining an entity type. All bundle fields require an associated storage
Chris@18:  * definition. A storage definition may have automatically been defined when
Chris@18:  * overriding a base field or it may be manually provided via
Chris@18:  * hook_entity_field_storage_info().
Chris@18:  *
Chris@18:  * @see \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()
Chris@18:  * @see \Drupal\Core\Field\FieldDefinitionInterface
Chris@18:  * @see \Drupal\Core\Field\FieldStorageDefinitionInterface
Chris@18:  * @see hook_entity_bundle_field_info()
Chris@18:  * @see hook_entity_field_storage_info()
Chris@18:  */
Chris@18: class FieldDefinition extends ListDataDefinition implements FieldDefinitionInterface {
Chris@18: 
Chris@18:   use UnchangingCacheableDependencyTrait;
Chris@18:   use FieldInputValueNormalizerTrait;
Chris@18: 
Chris@18:   /**
Chris@18:    * The associated field storage definition.
Chris@18:    *
Chris@18:    * @var \Drupal\Core\Field\FieldStorageDefinitionInterface
Chris@18:    */
Chris@18:   protected $fieldStorageDefinition;
Chris@18: 
Chris@18:   /**
Chris@18:    * Creates a new field definition.
Chris@18:    *
Chris@18:    * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storageDefinition
Chris@18:    *   The associated field storage definition.
Chris@18:    *
Chris@18:    * @return static
Chris@18:    */
Chris@18:   public static function createFromFieldStorageDefinition(FieldStorageDefinitionInterface $storageDefinition) {
Chris@18:     $field_definition = new static();
Chris@18:     $field_definition->setFieldStorageDefinition($storageDefinition);
Chris@18:     return $field_definition;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getName() {
Chris@18:     return $this->getFieldStorageDefinition()->getName();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getType() {
Chris@18:     return $this->getFieldStorageDefinition()->getType();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getTargetEntityTypeId() {
Chris@18:     return $this->getFieldStorageDefinition()->getTargetEntityTypeId();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Set the target bundle.
Chris@18:    *
Chris@18:    * @param string $bundle
Chris@18:    *   The target bundle.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setTargetBundle($bundle) {
Chris@18:     $this->definition['bundle'] = $bundle;
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getTargetBundle() {
Chris@18:     return $this->definition['bundle'];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Sets whether the display for the field can be configured.
Chris@18:    *
Chris@18:    * @param string $display_context
Chris@18:    *   The display context. Either 'view' or 'form'.
Chris@18:    * @param bool $configurable
Chris@18:    *   Whether the display options can be configured (e.g., via the "Manage
Chris@18:    *   display" / "Manage form display" UI screens). If TRUE, the options
Chris@18:    *   specified via getDisplayOptions() act as defaults.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setDisplayConfigurable($display_context, $configurable) {
Chris@18:     // If no explicit display options have been specified, default to 'hidden'.
Chris@18:     if (empty($this->definition['display'][$display_context])) {
Chris@18:       $this->definition['display'][$display_context]['options'] = ['region' => 'hidden'];
Chris@18:     }
Chris@18:     $this->definition['display'][$display_context]['configurable'] = $configurable;
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function isDisplayConfigurable($display_context) {
Chris@18:     return isset($this->definition['display'][$display_context]['configurable']) ? $this->definition['display'][$display_context]['configurable'] : FALSE;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Sets the display options for the field in forms or rendered entities.
Chris@18:    *
Chris@18:    * This enables generic rendering of the field with widgets / formatters,
Chris@18:    * including automated support for "In place editing", and with optional
Chris@18:    * configurability in the "Manage display" / "Manage form display" UI screens.
Chris@18:    *
Chris@18:    * Unless this method is called, the field remains invisible (or requires
Chris@18:    * ad-hoc rendering logic).
Chris@18:    *
Chris@18:    * @param string $display_context
Chris@18:    *   The display context. Either 'view' or 'form'.
Chris@18:    * @param array $options
Chris@18:    *   An array of display options. Refer to
Chris@18:    *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
Chris@18:    *   a list of supported keys. The options should include at least a 'weight',
Chris@18:    *   or specify 'type' = 'hidden'. The 'default_widget' / 'default_formatter'
Chris@18:    *   for the field type will be used if no 'type' is specified.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setDisplayOptions($display_context, array $options) {
Chris@18:     $this->definition['display'][$display_context]['options'] = $options;
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getDisplayOptions($display_context) {
Chris@18:     return isset($this->definition['display'][$display_context]['options']) ? $this->definition['display'][$display_context]['options'] : NULL;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getDefaultValueLiteral() {
Chris@18:     return isset($this->definition['default_value']) ? $this->definition['default_value'] : [];
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Set the default value callback for the field.
Chris@18:    *
Chris@18:    * @param string $callback
Chris@18:    *   The default value callback.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setDefaultValueCallback($callback) {
Chris@18:     if (isset($callback) && !is_string($callback)) {
Chris@18:       throw new \InvalidArgumentException('Default value callback must be a string, like "function_name" or "ClassName::methodName"');
Chris@18:     }
Chris@18:     $this->definition['default_value_callback'] = $callback;
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getDefaultValueCallback() {
Chris@18:     return isset($this->definition['default_value_callback']) ? $this->definition['default_value_callback'] : NULL;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Set a default value for the field.
Chris@18:    *
Chris@18:    * @param mixed $value
Chris@18:    *   The default value.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setDefaultValue($value) {
Chris@18:     $this->definition['default_value'] = $this->normalizeValue($value, $this->getFieldStorageDefinition()->getMainPropertyName());
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getDefaultValue(FieldableEntityInterface $entity) {
Chris@18:     // Allow custom default values function.
Chris@18:     if ($callback = $this->getDefaultValueCallback()) {
Chris@18:       $value = call_user_func($callback, $entity, $this);
Chris@18:     }
Chris@18:     else {
Chris@18:       $value = $this->getDefaultValueLiteral();
Chris@18:     }
Chris@18:     $value = $this->normalizeValue($value, $this->getFieldStorageDefinition()->getMainPropertyName());
Chris@18:     // Allow the field type to process default values.
Chris@18:     $field_item_list_class = $this->getClass();
Chris@18:     return $field_item_list_class::processDefaultValue($value, $entity, $this);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Sets whether the field is translatable.
Chris@18:    *
Chris@18:    * @param bool $translatable
Chris@18:    *   Whether the field is translatable.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setTranslatable($translatable) {
Chris@18:     $this->definition['translatable'] = $translatable;
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function isTranslatable() {
Chris@18:     return !empty($this->definition['translatable']) && $this->getFieldStorageDefinition()->isTranslatable();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Set the field storage definition.
Chris@18:    *
Chris@18:    * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storageDefinition
Chris@18:    *   The field storage definition associated with this field definition.
Chris@18:    *
Chris@18:    * @return $this
Chris@18:    */
Chris@18:   public function setFieldStorageDefinition(FieldStorageDefinitionInterface $storageDefinition) {
Chris@18:     $this->fieldStorageDefinition = $storageDefinition;
Chris@18:     $this->itemDefinition = FieldItemDataDefinition::create($this);
Chris@18:     // Create a definition for the items, and initialize it with the default
Chris@18:     // settings for the field type.
Chris@18:     $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
Chris@18:     $default_settings = $field_type_manager->getDefaultFieldSettings($storageDefinition->getType());
Chris@18:     $this->itemDefinition->setSettings($default_settings);
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getFieldStorageDefinition() {
Chris@18:     return $this->fieldStorageDefinition;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getConfig($bundle) {
Chris@18:     // @todo provide a FieldDefinitionOverride config entity in
Chris@18:     // https://www.drupal.org/project/drupal/issues/2935978.
Chris@18:     throw new \Exception('Field definitions do not currently have an override config entity.');
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getUniqueIdentifier() {
Chris@18:     return $this->getTargetEntityTypeId() . '-' . $this->getTargetBundle() . '-' . $this->getName();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getSetting($setting_name) {
Chris@18:     if (array_key_exists($setting_name, $this->itemDefinition->getSettings())) {
Chris@18:       return $this->itemDefinition->getSetting($setting_name);
Chris@18:     }
Chris@18:     else {
Chris@18:       return $this->getFieldStorageDefinition()->getSetting($setting_name);
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function getSettings() {
Chris@18:     return $this->getItemDefinition()->getSettings() + $this->getFieldStorageDefinition()->getSettings();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function setSetting($setting_name, $value) {
Chris@18:     $this->getItemDefinition()->setSetting($setting_name, $value);
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function setSettings(array $settings) {
Chris@18:     // Assign settings individually, in order to keep the current values
Chris@18:     // of settings not specified in $settings.
Chris@18:     foreach ($settings as $setting_name => $setting) {
Chris@18:       $this->getItemDefinition()->setSetting($setting_name, $setting);
Chris@18:     }
Chris@18:     return $this;
Chris@18:   }
Chris@18: 
Chris@18: }