abstract class 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

4 files declare their use of TypedData
EntityTranslation.php in drupal/core/lib/Drupal/Core/Entity/Field/Type/EntityTranslation.php
Definition of Drupal\Core\Entity\Type\EntityTranslation.
EntityWrapper.php in drupal/core/lib/Drupal/Core/Entity/Field/Type/EntityWrapper.php
Definition of Drupal\Core\Entity\Field\Type\EntityWrapper.
Field.php in drupal/core/lib/Drupal/Core/Entity/Field/Type/Field.php
Definition of Drupal\Core\Entity\Field\Type\Field.
FieldItemBase.php in drupal/core/lib/Drupal/Core/Entity/Field/FieldItemBase.php
Definition of Drupal\Core\Entity\Field\FieldItemBase.

File

drupal/core/lib/Drupal/Core/TypedData/Type/TypedData.php, line 18
Definition of Drupal\Core\TypedData\Type\TypedData.

Namespace

Drupal\Core\TypedData\Type
View source
abstract class TypedData implements TypedDataInterface {

  /**
   * The data definition.
   *
   * @var array
   */
  protected $definition;

  /**
   * Constructs a TypedData object given its definition.
   *
   * @param array $definition
   *   The data definition.
   *
   * @see Drupal\Core\TypedData\TypedDataManager::create()
   */
  public function __construct(array $definition) {
    $this->definition = $definition;
  }

  /**
   * Implements TypedDataInterface::getType().
   */
  public function getType() {
    return $this->definition['type'];
  }

  /**
   * Implements TypedDataInterface::getDefinition().
   */
  public function getDefinition() {
    return $this->definition;
  }

  /**
   * Implements TypedDataInterface::getValue().
   */
  public function getValue() {
    return $this->value;
  }

  /**
   * Implements TypedDataInterface::setValue().
   */
  public function setValue($value) {
    $this->value = $value;
  }

  /**
   * Implements TypedDataInterface::getString().
   */
  public function getString() {
    return (string) $this
      ->getValue();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
TypedData::$definition protected property The data definition.
TypedData::getDefinition public function Implements TypedDataInterface::getDefinition(). Overrides TypedDataInterface::getDefinition
TypedData::getString public function Implements TypedDataInterface::getString(). Overrides TypedDataInterface::getString 8
TypedData::getType public function Implements TypedDataInterface::getType(). Overrides TypedDataInterface::getType
TypedData::getValue public function Implements TypedDataInterface::getValue(). Overrides TypedDataInterface::getValue 7
TypedData::setValue public function Implements TypedDataInterface::setValue(). Overrides TypedDataInterface::setValue 13
TypedData::__construct public function Constructs a TypedData object given its definition. 3
TypedDataInterface::validate public function Validates the currently set data value. 13