class TypedData

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/TypedData/TypedData.php \Drupal\Core\TypedData\TypedData
  2. 10 core/lib/Drupal/Core/TypedData/TypedData.php \Drupal\Core\TypedData\TypedData
  3. 8.9.x core/lib/Drupal/Core/TypedData/TypedData.php \Drupal\Core\TypedData\TypedData

The abstract base class for typed data.

Classes deriving from this base class have to declare $value or override getValue() or setValue().

Hierarchy

Expanded class hierarchy of TypedData

Related topics

12 files declare their use of TypedData
Any.php in core/lib/Drupal/Core/TypedData/Plugin/DataType/Any.php
ComputedFileUrl.php in core/modules/file/src/ComputedFileUrl.php
ComputedString.php in core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php
DateTimeComputed.php in core/modules/datetime/src/DateTimeComputed.php
Element.php in core/lib/Drupal/Core/Config/Schema/Element.php

... See full list

1 string reference to 'TypedData'
ContentEntityCloneTest::testEntityPropertiesModifications in core/tests/Drupal/KernelTests/Core/Entity/ContentEntityCloneTest.php
Tests references of entity properties after entity cloning.

File

core/lib/Drupal/Core/TypedData/TypedData.php, line 17

Namespace

Drupal\Core\TypedData
View source
abstract class TypedData implements TypedDataInterface, PluginInspectionInterface {
  use DependencySerializationTrait;
  use StringTranslationTrait;
  use TypedDataTrait;
  
  /**
   * The data definition.
   *
   * @var \Drupal\Core\TypedData\DataDefinitionInterface
   */
  protected $definition;
  
  /**
   * The property name.
   *
   * @var string
   */
  protected $name;
  
  /**
   * The parent typed data object.
   *
   * @var \Drupal\Core\TypedData\TraversableTypedDataInterface|null
   */
  protected $parent;
  
  /**
   * {@inheritdoc}
   */
  public static function createInstance($definition, $name = NULL, TraversableTypedDataInterface $parent = NULL) {
    return new static($definition, $name, $parent);
  }
  
  /**
   * 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()
   */
  public function __construct(DataDefinitionInterface $definition, $name = NULL, TypedDataInterface $parent = NULL) {
    $this->definition = $definition;
    $this->parent = $parent;
    $this->name = $name;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPluginId() {
    return $this->definition['type'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPluginDefinition() {
    return $this->getTypedDataManager()
      ->getDefinition($this->definition
      ->getDataType());
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDataDefinition() {
    return $this->definition;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getValue() {
    return $this->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setValue($value, $notify = TRUE) {
    $this->value = $value;
    // Notify the parent of any changes.
    if ($notify && isset($this->parent)) {
      $this->parent
        ->onChange($this->name);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getString() {
    return (string) $this->getValue();
  }
  
  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraint_manager = $this->getTypedDataManager()
      ->getValidationConstraintManager();
    $constraints = [];
    foreach ($this->definition
      ->getConstraints() as $name => $options) {
      $constraints[] = $constraint_manager->create($name, $options);
    }
    return $constraints;
  }
  
  /**
   * {@inheritdoc}
   */
  public function validate() {
    return $this->getTypedDataManager()
      ->getValidator()
      ->validate($this);
  }
  
  /**
   * {@inheritdoc}
   */
  public function applyDefaultValue($notify = TRUE) {
    // Default to no default value.
    $this->setValue(NULL, $notify);
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setContext($name = NULL, TraversableTypedDataInterface $parent = NULL) {
    $this->parent = $parent;
    $this->name = $name;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->name;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRoot() {
    if (isset($this->parent)) {
      return $this->parent
        ->getRoot();
    }
    // If no parent is set, this is the root of the data tree.
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPropertyPath() {
    if (isset($this->parent)) {
      // The property path of this data object is the parent's path appended
      // by this object's name.
      $prefix = $this->parent
        ->getPropertyPath();
      return (strlen($prefix) ? $prefix . '.' : '') . $this->name;
    }
    elseif (isset($this->name)) {
      return $this->name;
    }
    return '';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getParent() {
    return $this->parent;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.