class EntityRevisionDataDefinition in Entity Reference Revisions 8

A typed data definition class for describing entities.

Hierarchy

• class \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ArrayAccess, DataDefinitionInterface uses TypedDataTrait
  • class \Drupal\Core\TypedData\ComplexDataDefinitionBase implements ComplexDataDefinitionInterface
    • class \Drupal\Core\Entity\TypedData\EntityDataDefinition implements EntityDataDefinitionInterface
      • class \Drupal\entity_reference_revisions\TypedData\EntityRevisionDataDefinition implements EntityDataDefinitionInterface

File

src/TypedData/EntityRevisionDataDefinition.php, line 11

Namespace

Drupal\entity_reference_revisions\TypedData

class EntityRevisionDataDefinition extends EntityDataDefinition implements EntityDataDefinitionInterface {

  /**
   * {@inheritdoc}
   */
  public static function createFromDataType($data_type) {
    $parts = explode(':', $data_type);
    if ($parts[0] != 'entity_revision') {
      throw new \InvalidArgumentException('Data type must be in the form of "entity_revision: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 getDataType() {
    $type = 'entity_revision';
    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;
  }

}

Members

Name	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	Overrides DataDefinition::__sleep
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	2
DataDefinition::getSettings	public	function	Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings	2
DataDefinition::isComputed	public	function	Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isInternal	public	function	Determines whether the data value is internal. Overrides DataDefinitionInterface::isInternal	1
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	Sets an array of validation constraints.
DataDefinition::setDataType	public	function	Sets the data type.	1
DataDefinition::setDescription	public	function	Sets the human-readable description.
DataDefinition::setInternal	public	function	Sets the whether the data value should be internal.
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.	2
DataDefinition::setSettings	public	function	Sets the array of settings, as required by the used class.	2
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::getBundles	public	function	Gets the array of possible entity bundles. Overrides EntityDataDefinitionInterface::getBundles
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
EntityRevisionDataDefinition::createFromDataType	public static	function	Creates a new data definition object. Overrides EntityDataDefinition::createFromDataType
EntityRevisionDataDefinition::getDataType	public	function	Returns the data type of the data. Overrides EntityDataDefinition::getDataType
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2