class EntityReferenceItem

Defines the 'entity_reference' entity field item.

Required settings (below the definition's 'settings' key) are:

  • target_type: The entity type to reference.

Hierarchy

Expanded class hierarchy of EntityReferenceItem

1 file declares its use of EntityReferenceItem

File

drupal/core/lib/Drupal/Core/Entity/Field/Type/EntityReferenceItem.php, line 19
Contains \Drupal\Core\Entity\Field\Type\EntityReferenceItem.

Namespace

Drupal\Core\Entity\Field\Type
View source
class EntityReferenceItem extends FieldItemBase {

  /**
   * Definitions of the contained properties.
   *
   * @see EntityReferenceItem::getPropertyDefinitions()
   *
   * @var array
   */
  static $propertyDefinitions;

  /**
   * Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinitions().
   */
  public function getPropertyDefinitions() {

    // Definitions vary by entity type, so key them by entity type.
    $target_type = $this->definition['settings']['target_type'];
    if (!isset(self::$propertyDefinitions[$target_type])) {
      static::$propertyDefinitions[$target_type]['target_id'] = array(
        // @todo: Lookup the entity type's ID data type and use it here.
        'type' => 'integer',
        'label' => t('Entity ID'),
        'constraints' => array(
          'Range' => array(
            'min' => 0,
          ),
        ),
      );
      static::$propertyDefinitions[$target_type]['entity'] = array(
        'type' => 'entity',
        'constraints' => array(
          'EntityType' => $target_type,
        ),
        'label' => t('Entity'),
        'description' => t('The referenced entity'),
        // The entity object is computed out of the entity ID.
        'computed' => TRUE,
        'read-only' => FALSE,
        'settings' => array(
          'id source' => 'target_id',
        ),
      );
    }
    return static::$propertyDefinitions[$target_type];
  }

  /**
   * Overrides \Drupal\Core\Entity\Field\FieldItemBase::__get().
   */
  public function __get($name) {
    $name = $name == 'value' ? 'target_id' : $name;
    return parent::__get($name);
  }

  /**
   * Overrides \Drupal\Core\Entity\Field\FieldItemBase::get().
   */
  public function get($property_name) {
    $property_name = $property_name == 'value' ? 'target_id' : $property_name;
    return parent::get($property_name);
  }

  /**
   * Implements \Drupal\Core\Entity\Field\FieldItemInterface::__isset().
   */
  public function __isset($property_name) {
    $property_name = $property_name == 'value' ? 'target_id' : $property_name;
    return parent::__isset($property_name);
  }

  /**
   * Overrides \Drupal\Core\Entity\Field\FieldItemBase::get().
   */
  public function setValue($values, $notify = TRUE) {

    // Treat the values as property value of the entity property, if no array is
    // given.
    if (isset($values) && !is_array($values)) {
      $values = array(
        'entity' => $values,
      );
    }

    // Make sure that the 'entity' property gets set as 'target_id'.
    if (isset($values['target_id']) && !isset($values['entity'])) {
      $values['entity'] = $values['target_id'];
    }
    parent::setValue($values, $notify);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityReferenceItem::$propertyDefinitions static property Definitions of the contained properties. 1
EntityReferenceItem::get public function Overrides \Drupal\Core\Entity\Field\FieldItemBase::get(). Overrides Map::get
EntityReferenceItem::getPropertyDefinitions public function Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinitions(). Overrides Map::getPropertyDefinitions 1
EntityReferenceItem::setValue public function Overrides \Drupal\Core\Entity\Field\FieldItemBase::get(). Overrides FieldItemBase::setValue
EntityReferenceItem::__get public function Overrides \Drupal\Core\Entity\Field\FieldItemBase::__get(). Overrides FieldItemBase::__get
EntityReferenceItem::__isset public function Implements \Drupal\Core\Entity\Field\FieldItemInterface::__isset(). Overrides FieldItemBase::__isset
FieldItemBase::getConstraints public function Implements \Drupal\Core\TypedData\TypedDataInterface::getConstraints(). Overrides TypedData::getConstraints
FieldItemBase::onChange public function Overrides \Drupal\Core\TypedData\Map::onChange(). Overrides Map::onChange
FieldItemBase::set public function Overrides \Drupal\Core\TypedData\Type\Map::set(). Overrides Map::set
FieldItemBase::__construct public function Overrides \Drupal\Core\TypedData\TypedData::__construct(). Overrides TypedData::__construct
FieldItemBase::__set public function Implements \Drupal\Core\Entity\Field\FieldItemInterface::__set(). Overrides FieldItemInterface::__set
FieldItemBase::__unset public function Implements \Drupal\Core\Entity\Field\FieldItemInterface::__unset(). Overrides FieldItemInterface::__unset
Map::$properties protected property The array of properties, each implementing the TypedDataInterface.
Map::$values protected property An array of values for the contained properties.
Map::getIterator public function Implements \IteratorAggregate::getIterator().
Map::getProperties public function Implements \Drupal\Core\TypedData\ComplexDataInterface::getProperties(). Overrides ComplexDataInterface::getProperties
Map::getPropertyDefinition public function Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyDefinition(). Overrides ComplexDataInterface::getPropertyDefinition
Map::getPropertyValues public function Implements \Drupal\Core\TypedData\ComplexDataInterface::getPropertyValues(). Overrides ComplexDataInterface::getPropertyValues
Map::getString public function Overrides \Drupal\Core\TypedData\TypedData::getString(). Overrides TypedData::getString
Map::getValue public function Overrides \Drupal\Core\TypedData\TypedData::getValue(). Overrides TypedData::getValue
Map::isEmpty public function Implements \Drupal\Core\TypedData\ComplexDataInterface::isEmpty(). Overrides ComplexDataInterface::isEmpty 1
Map::setPropertyValues public function Implements \Drupal\Core\TypedData\ComplexDataInterface::setPropertyValues(). Overrides ComplexDataInterface::setPropertyValues
Map::__clone public function Magic method: Implements a deep clone.
TypedData::$definition protected property The data definition.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::getDefinition public function Implements \Drupal\Core\TypedData\TypedDataInterface::getDefinition(). Overrides TypedDataInterface::getDefinition
TypedData::getName public function Implements \Drupal\Core\TypedData\TypedDataInterface::getName(). Overrides TypedDataInterface::getName
TypedData::getParent public function Implements \Drupal\Core\TypedData\TypedDataInterface::getParent(). Overrides TypedDataInterface::getParent
TypedData::getPropertyPath public function Implements \Drupal\Core\TypedData\TypedDataInterface::getPropertyPath(). Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Implements \Drupal\Core\TypedData\TypedDataInterface::getRoot(). Overrides TypedDataInterface::getRoot
TypedData::getType public function Implements \Drupal\Core\TypedData\TypedDataInterface::getType(). Overrides TypedDataInterface::getType
TypedData::setContext public function Implements \Drupal\Core\TypedData\TypedDataInterface::setContext(). Overrides TypedDataInterface::setContext 1
TypedData::validate public function Implements \Drupal\Core\TypedData\TypedDataInterface::validate(). Overrides TypedDataInterface::validate 3