interface ResourceFieldResourceInterface in RESTful 7.2

Hierarchy

• interface \Drupal\restful\Plugin\resource\Field\ResourceFieldInterface
  • interface \Drupal\restful\Plugin\resource\Field\ResourceFieldResourceInterface

4 files declare their use of ResourceFieldResourceInterface

DataProviderEntity.php in src/Plugin/resource/DataProvider/DataProviderEntity.php

Contains \Drupal\restful\Plugin\resource\DataProvider\DataProviderEntity.

FormatterHalJson.php in src/Plugin/formatter/FormatterHalJson.php

Contains \Drupal\restful\Plugin\formatter\FormatterHalJson.

FormatterJson.php in src/Plugin/formatter/FormatterJson.php

Contains \Drupal\restful\Plugin\formatter\FormatterJson.

FormatterJsonApi.php in src/Plugin/formatter/FormatterJsonApi.php

Contains \Drupal\restful\Plugin\formatter\FormatterJsonApi.

File

src/Plugin/resource/Field/ResourceFieldResourceInterface.php, line 13

Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldResourceInterface.

Namespace

Drupal\restful\Plugin\resource\Field

interface ResourceFieldResourceInterface extends ResourceFieldInterface {

  /**
   * Gets the ID on the referenced resource.
   *
   * @param DataInterpreterInterface $interpreter
   *   The data interpreter to get the compound ID.
   *
   * @return string|string[]
   *   The identifier(s) used to access the resource.
   */
  public function getResourceId(DataInterpreterInterface $interpreter);

  /**
   * Gets the machine name, without version, of the referenced resource.
   *
   * @return string
   *   The name.
   */
  public function getResourceMachineName();

  /**
   * Gets the destination resource plugin.
   *
   * @return ResourceInterface
   *   The plugin.
   */
  public function getResourcePlugin();

  /**
   * Gets the table column for joins.
   *
   * @return string
   *   The column to make a join for nested filters.
   */
  public function getTargetColumn();

}

Members

Name	Modifiers	Type	Description	Overrides
ResourceFieldInterface::access	public	function	Check access on property by the defined access callbacks.	3
ResourceFieldInterface::addDefaults	public	function	Adds the default values to the definitions array.	3
ResourceFieldInterface::addMetadata	public	function	Add metadata to the field.	3
ResourceFieldInterface::compoundDocumentId	public	function	Fetches the embedded identifier(s) for the current resource field, if any.	3
ResourceFieldInterface::create	public static	function	Factory.	3
ResourceFieldInterface::executeProcessCallbacks	public	function	Executes the process callbacks.	3
ResourceFieldInterface::getAccessCallbacks	public	function		3
ResourceFieldInterface::getCallback	public	function		3
ResourceFieldInterface::getCardinality	public	function	Gets the cardinality of the wrapped field.	3
ResourceFieldInterface::getDefinition	public	function	Gets the original field definition as declared in Resource::publicFields().	3
ResourceFieldInterface::getMetadata	public	function	Add metadata to the field.	3
ResourceFieldInterface::getMethods	public	function		3
ResourceFieldInterface::getProcessCallbacks	public	function		3
ResourceFieldInterface::getProperty	public	function		3
ResourceFieldInterface::getPublicFieldInfo	public	function	Gets the public field info object.	3
ResourceFieldInterface::getPublicName	public	function		3
ResourceFieldInterface::getRequest	public	function	Get the request in the data provider.	3
ResourceFieldInterface::getResource	public	function		3
ResourceFieldInterface::id	public	function	Gets the ID of the resource field.	3
ResourceFieldInterface::isArrayNumeric	public static	function	Helper method to determine if an array is numeric.	3
ResourceFieldInterface::isComputed	public	function	Checks if the current field is computed.	3
ResourceFieldInterface::render	public	function	Gets the value of a field and applies all process callbacks to it.	3
ResourceFieldInterface::set	public	function	Gets the value for the field given a data source.	3
ResourceFieldInterface::setAccessCallbacks	public	function		3
ResourceFieldInterface::setCallback	public	function		3
ResourceFieldInterface::setCardinality	public	function	Set the cardinality.	3
ResourceFieldInterface::setMethods	public	function		3
ResourceFieldInterface::setProcessCallbacks	public	function		3
ResourceFieldInterface::setProperty	public	function		3
ResourceFieldInterface::setPublicFieldInfo	public	function	Gets the public field info object.	3
ResourceFieldInterface::setPublicName	public	function		3
ResourceFieldInterface::setRequest	public	function	Set the request.	3
ResourceFieldInterface::setResource	public	function		3
ResourceFieldInterface::value	public	function	Gets the value for the field given a data source.	3
ResourceFieldResourceInterface::getResourceId	public	function	Gets the ID on the referenced resource.	1
ResourceFieldResourceInterface::getResourceMachineName	public	function	Gets the machine name, without version, of the referenced resource.	1
ResourceFieldResourceInterface::getResourcePlugin	public	function	Gets the destination resource plugin.	1
ResourceFieldResourceInterface::getTargetColumn	public	function	Gets the table column for joins.	1