You are here

public function ResourceFieldInterface::compoundDocumentId in RESTful 7.2

Fetches the embedded identifier(s) for the current resource field, if any.

Parameters

DataInterpreterInterface $interpreter: The data interpreter to get the compound ID.

Return value

string|string[] An identifier or an array of identifiers for cardinality > 1. NULL if there is no identifier to be found.

3 methods override ResourceFieldInterface::compoundDocumentId()
ResourceField::compoundDocumentId in src/Plugin/resource/Field/ResourceField.php
Fetches the embedded identifier(s) for the current resource field, if any.
ResourceFieldEntity::compoundDocumentId in src/Plugin/resource/Field/ResourceFieldEntity.php
Fetches the embedded identifier(s) for the current resource field, if any.
ResourceFieldResource::compoundDocumentId in src/Plugin/resource/Field/ResourceFieldResource.php
Fetches the embedded identifier(s) for the current resource field, if any.

File

src/Plugin/resource/Field/ResourceFieldInterface.php, line 231
Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldInterface.

Class

ResourceFieldInterface

Namespace

Drupal\restful\Plugin\resource\Field

Code

public function compoundDocumentId(DataInterpreterInterface $interpreter);