You are here

Home » API reference » Zircon Profile 8 » EntityDataDefinition.php

class EntityDataDefinition in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php \Drupal\Core\Entity\TypedData\EntityDataDefinition

A typed data definition class for describing entities.

Hierarchy

Expanded class hierarchy of EntityDataDefinition

3 files declare their use of EntityDataDefinition
EntityAdapter.php in core/lib/Drupal/Core/Entity/Plugin/DataType/EntityAdapter.php
Contains \Drupal\Core\Entity\Plugin\DataType\EntityAdapter.
EntityReferenceItem.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php
Contains \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem.
EntityTypedDataDefinitionTest.php in core/modules/system/src/Tests/Entity/EntityTypedDataDefinitionTest.php
Contains \Drupal\system\Tests\Entity\EntityTypedDataDefinitionTest.

File

core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php, line 15
Contains \Drupal\Core\Entity\TypedData\EntityDataDefinition.

Namespace

Drupal\Core\Entity\TypedData
View source 
class EntityDataDefinition extends ComplexDataDefinitionBase implements EntityDataDefinitionInterface {

  /**
   * Creates a new entity definition.
   *
   * @param string $entity_type_id
   *   (optional) The ID of the entity type, or NULL if the entity type is
   *   unknown. Defaults to NULL.
   *
   * @return static
   */
  public static function create($entity_type_id = NULL) {
    $definition = new static(array());

    // Set the passed entity type.
    if (isset($entity_type_id)) {
      $definition
        ->setEntityTypeId($entity_type_id);
    }
    return $definition;
  }

  /**
   * {@inheritdoc}
   */
  public static function createFromDataType($data_type) {
    $parts = explode(':', $data_type);
    if ($parts[0] != 'entity') {
      throw new \InvalidArgumentException('Data type must be in the form of "entity:ENTITY_TYPE:BUNDLE."');
    }
    $definition = static::create();

    // Set the passed entity type and bundle.
    if (isset($parts[1])) {
      $definition
        ->setEntityTypeId($parts[1]);
    }
    if (isset($parts[2])) {
      $definition
        ->setBundles(array(
        $parts[2],
      ));
    }
    return $definition;
  }

  /**
   * {@inheritdoc}
   */
  public function getPropertyDefinitions() {
    if (!isset($this->propertyDefinitions)) {
      if ($entity_type_id = $this
        ->getEntityTypeId()) {

        // Return an empty array for entities that are not content entities.
        $entity_type_class = \Drupal::entityManager()
          ->getDefinition($entity_type_id)
          ->getClass();
        if (!in_array('Drupal\\Core\\Entity\\FieldableEntityInterface', class_implements($entity_type_class))) {
          $this->propertyDefinitions = array();
        }
        else {

          // @todo: Add support for handling multiple bundles.
          // See https://www.drupal.org/node/2169813.
          $bundles = $this
            ->getBundles();
          if (is_array($bundles) && count($bundles) == 1) {
            $this->propertyDefinitions = \Drupal::entityManager()
              ->getFieldDefinitions($entity_type_id, reset($bundles));
          }
          else {
            $this->propertyDefinitions = \Drupal::entityManager()
              ->getBaseFieldDefinitions($entity_type_id);
          }
        }
      }
      else {

        // No entity type given.
        $this->propertyDefinitions = array();
      }
    }
    return $this->propertyDefinitions;
  }

  /**
   * {@inheritdoc}
   */
  public function getDataType() {
    $type = 'entity';
    if ($entity_type = $this
      ->getEntityTypeId()) {
      $type .= ':' . $entity_type;

      // Append the bundle only if we know it for sure and it is not the default
      // bundle.
      if (($bundles = $this
        ->getBundles()) && count($bundles) == 1) {
        $bundle = reset($bundles);
        if ($bundle != $entity_type) {
          $type .= ':' . $bundle;
        }
      }
    }
    return $type;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityTypeId() {
    return isset($this->definition['constraints']['EntityType']) ? $this->definition['constraints']['EntityType'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setEntityTypeId($entity_type_id) {
    return $this
      ->addConstraint('EntityType', $entity_type_id);
  }

  /**
   * {@inheritdoc}
   */
  public function getBundles() {
    $bundle = isset($this->definition['constraints']['Bundle']) ? $this->definition['constraints']['Bundle'] : NULL;
    return is_string($bundle) ? array(
      $bundle,
    ) : $bundle;
  }

  /**
   * {@inheritdoc}
   */
  public function setBundles(array $bundles = NULL) {
    if (isset($bundles)) {
      $this
        ->addConstraint('Bundle', $bundles);
    }
    else {

      // Remove the constraint.
      unset($this->definition['constraints']['Bundle']);
    }
    return $this;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ComplexDataDefinitionBase::$propertyDefinitions protected property An array of data definitions.
ComplexDataDefinitionBase::getMainPropertyName public function Returns the name of the main property, if any. Overrides ComplexDataDefinitionInterface::getMainPropertyName 1
ComplexDataDefinitionBase::getPropertyDefinition public function Gets the definition of a contained property. Overrides ComplexDataDefinitionInterface::getPropertyDefinition
ComplexDataDefinitionBase::__sleep public function
DataDefinition::$definition protected property The array holding values for all definition keys.
DataDefinition::addConstraint public function Adds a validation constraint. Overrides DataDefinitionInterface::addConstraint
DataDefinition::getClass public function Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass 1
DataDefinition::getConstraint public function Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints public function Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints 1
DataDefinition::getDescription public function Returns a human readable description. Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel public function Returns a human readable label. Overrides DataDefinitionInterface::getLabel
DataDefinition::getSetting public function Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting 1
DataDefinition::getSettings public function Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings 1
DataDefinition::isComputed public function Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isList public function Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly public function Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired public function Determines whether a data value is required. Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetGet public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetSet public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetUnset public function This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::setClass public function Sets the class used for creating the typed data object.
DataDefinition::setComputed public function Sets whether the data is computed.
DataDefinition::setConstraints public function
DataDefinition::setDataType public function Sets the data type. 1
DataDefinition::setDescription public function Sets the human-readable description.
DataDefinition::setLabel public function Sets the human-readable label.
DataDefinition::setReadOnly public function Sets whether the data is read-only.
DataDefinition::setRequired public function Sets whether the data is required.
DataDefinition::setSetting public function Sets a definition setting. 1
DataDefinition::setSettings public function Sets the array of settings, as required by the used class. 1
DataDefinition::toArray public function Returns all definition values as array.
DataDefinition::__construct public function Constructs a new data definition object. 1
EntityDataDefinition::create public static function Creates a new entity definition. Overrides DataDefinition::create
EntityDataDefinition::createFromDataType public static function Creates a new data definition object. Overrides DataDefinition::createFromDataType
EntityDataDefinition::getBundles public function Gets the array of possible entity bundles. Overrides EntityDataDefinitionInterface::getBundles
EntityDataDefinition::getDataType public function Returns the data type of the data. Overrides DataDefinition::getDataType
EntityDataDefinition::getEntityTypeId public function Gets the entity type ID. Overrides EntityDataDefinitionInterface::getEntityTypeId
EntityDataDefinition::getPropertyDefinitions public function Gets an array of property definitions of contained properties. Overrides ComplexDataDefinitionBase::getPropertyDefinitions
EntityDataDefinition::setBundles public function Sets the array of possible entity bundles. Overrides EntityDataDefinitionInterface::setBundles
EntityDataDefinition::setEntityTypeId public function Sets the entity type ID. Overrides EntityDataDefinitionInterface::setEntityTypeId