interface RelationalFilterInterface in RESTful 7.2

Interface RelationalFilterInterface.

@package Drupal\restful\Util

Hierarchy

• interface \Drupal\restful\Util\RelationalFilterInterface

1 file declares its use of RelationalFilterInterface

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

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

File

src/Util/RelationalFilterInterface.php, line 15

Contains \Drupal\restful\Util\RelationalFilterInterface.

Namespace

Drupal\restful\Util

interface RelationalFilterInterface {
  const TYPE_FIELD = 'field';
  const TYPE_PROPERTY = 'property';

  /**
   * Get the name.
   *
   * @return string
   *   The name.
   */
  public function getName();

  /**
   * Get the type.
   *
   * @return string
   *   The type.
   */
  public function getType();

  /**
   * Gets the entity type.
   *
   * @return string
   *   The type.
   */
  public function getEntityType();

  /**
   * The bundles.
   *
   * @return string[]
   *   Array of bundles.
   */
  public function getBundles();

  /**
   * Database column for field filters.
   *
   * @return string
   *   The DB column.
   */
  public function getColumn();

  /**
   * Database column for the target table relationship.
   *
   * @return string
   *   The DB column.
   */
  public function getTargetColumn();

}

Members

Name	Modifiers	Type	Description	Overrides
RelationalFilterInterface::getBundles	public	function	The bundles.	1
RelationalFilterInterface::getColumn	public	function	Database column for field filters.	1
RelationalFilterInterface::getEntityType	public	function	Gets the entity type.	1
RelationalFilterInterface::getName	public	function	Get the name.	1
RelationalFilterInterface::getTargetColumn	public	function	Database column for the target table relationship.	1
RelationalFilterInterface::getType	public	function	Get the type.	1
RelationalFilterInterface::TYPE_FIELD		constant
RelationalFilterInterface::TYPE_PROPERTY		constant