class RelationshipItem in JSON:API 8

Value object representing a JSON API relationship item.

@internal

Hierarchy

• class \Drupal\jsonapi\Normalizer\RelationshipItem

File

src/Normalizer/RelationshipItem.php, line 13

Namespace

Drupal\jsonapi\Normalizer

class RelationshipItem {

  /**
   * The target key name.
   *
   * @var string
   */
  protected $targetKey = 'target_id';

  /**
   * The target entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface|null
   */
  protected $targetEntity;

  /**
   * The target JSON API resource type.
   *
   * @var \Drupal\jsonapi\ResourceType\ResourceType
   */
  protected $targetResourceType;

  /**
   * The parent relationship.
   *
   * @var \Drupal\jsonapi\Normalizer\Relationship
   */
  protected $parent;

  /**
   * The list of metadata associated with this relationship item value.
   *
   * @var array
   */
  protected $metadata;

  /**
   * Relationship item constructor.
   *
   * @param \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface $resource_type_repository
   *   The JSON API resource type repository.
   * @param \Drupal\Core\Entity\EntityInterface|null $target_entity
   *   The entity this relationship points to, if any.
   * @param \Drupal\jsonapi\Normalizer\Relationship $parent
   *   The parent of this item.
   * @param string $target_key
   *   The key name of the target relationship.
   * @param array $metadata
   *   The list of metadata associated with this relationship item value.
   */
  public function __construct(ResourceTypeRepositoryInterface $resource_type_repository, $target_entity, Relationship $parent, $target_key = 'target_id', array $metadata = []) {
    assert($target_entity === NULL || $target_entity instanceof EntityInterface);
    if ($target_entity === NULL) {
      $host_entity = $parent
        ->getHostEntity();
      $relatable_resource_types = $resource_type_repository
        ->get($host_entity
        ->getEntityTypeId(), $host_entity
        ->bundle())
        ->getRelatableResourceTypes()[$parent
        ->getPropertyName()];
      if (count($relatable_resource_types) !== 1) {
        throw new \RuntimeException('Relationships to virtual resources are possible only if a single resource type is relatable.');
      }
      $this->targetResourceType = reset($relatable_resource_types);
    }
    else {
      $this->targetResourceType = $resource_type_repository
        ->get($target_entity
        ->getEntityTypeId(), $target_entity
        ->bundle());
    }
    $this->targetKey = $target_key;
    $this->targetEntity = $target_entity;
    $this->parent = $parent;
    $this->metadata = $metadata;
  }

  /**
   * Gets the target entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The target entity of this relationship item.
   */
  public function getTargetEntity() {
    return $this->targetEntity;
  }

  /**
   * Gets the targetResourceConfig.
   *
   * @return mixed
   *   The target of this relationship item.
   */
  public function getTargetResourceType() {
    return $this->targetResourceType;
  }

  /**
   * Gets the relationship value.
   *
   * Defaults to the entity ID.
   *
   * @return string
   *   The value of this relationship item.
   */
  public function getValue() {
    $target_uuid = $this->targetEntity === NULL ? 'virtual' : $this
      ->getTargetEntity()
      ->uuid();
    return [
      'target_uuid' => $target_uuid,
      'meta' => $this->metadata,
    ];
  }

  /**
   * Gets the relationship object that contains this relationship item.
   *
   * @return \Drupal\jsonapi\Normalizer\Relationship
   *   The parent relationship of this item.
   */
  public function getParent() {
    return $this->parent;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RelationshipItem::$metadata	protected	property	The list of metadata associated with this relationship item value.
RelationshipItem::$parent	protected	property	The parent relationship.
RelationshipItem::$targetEntity	protected	property	The target entity.
RelationshipItem::$targetKey	protected	property	The target key name.
RelationshipItem::$targetResourceType	protected	property	The target JSON API resource type.
RelationshipItem::getParent	public	function	Gets the relationship object that contains this relationship item.
RelationshipItem::getTargetEntity	public	function	Gets the target entity.
RelationshipItem::getTargetResourceType	public	function	Gets the targetResourceConfig.
RelationshipItem::getValue	public	function	Gets the relationship value.
RelationshipItem::__construct	public	function	Relationship item constructor.