You are here

interface ResourceFieldEntityAlterableInterface in RESTful 7.2

Class ResourceFieldFilterableInterface.

@package Drupal\restful\Plugin\resource\Field

Hierarchy

Expanded class hierarchy of ResourceFieldEntityAlterableInterface

All classes that implement ResourceFieldEntityAlterableInterface

1 file declares its use of ResourceFieldEntityAlterableInterface
DataProviderEntity.php in src/Plugin/resource/DataProvider/DataProviderEntity.php
Contains \Drupal\restful\Plugin\resource\DataProvider\DataProviderEntity.

File

src/Plugin/resource/Field/ResourceFieldEntityAlterableInterface.php, line 15
Contains \Drupal\restful\Plugin\resource\Field\ResourceFieldFilterableInterface.

Namespace

Drupal\restful\Plugin\resource\Field
View source
interface ResourceFieldEntityAlterableInterface {

  /**
   * Alter the list query to add the filtering for this field.
   *
   * @param array $filter
   *   The filter array definition.
   * @param \EntityFieldQuery $query
   *   The entity field query to modify.
   *
   * @return array
   *   The modified $filter array.
   */
  public function alterFilterEntityFieldQuery(array $filter, \EntityFieldQuery $query);

  /**
   * Alter the list query to add the sorting for this field.
   *
   * @param array $sort
   *   The sort array definition.
   * @param \EntityFieldQuery $query
   *   The entity field query to modify.
   *
   * @return array
   *   The modified $sort array.
   */
  public function alterSortEntityFieldQuery(array $sort, \EntityFieldQuery $query);

}

Members

Namesort descending Modifiers Type Description Overrides
ResourceFieldEntityAlterableInterface::alterFilterEntityFieldQuery public function Alter the list query to add the filtering for this field.
ResourceFieldEntityAlterableInterface::alterSortEntityFieldQuery public function Alter the list query to add the sorting for this field.