interface RestWSQueryResourceControllerInterface in RESTful Web Services 7.2

Specifies query methods for resources.

Hierarchy

• interface \RestWSResourceControllerInterface
  • interface \RestWSQueryResourceControllerInterface

File

./restws.entity.inc, line 94

RESTful web services module integration for entities.

interface RestWSQueryResourceControllerInterface extends RestWSResourceControllerInterface {

  /**
   * Query for a list of resources.
   *
   * @param array $filters
   *   A list of properties to query for, or an empty array if all resources
   *   should be counted.
   * @param array $meta_controls
   *   See restws_meta_controls()
   *
   * @return array
   *   An array containing the ids of the matching resources.
   */
  public function query($filters = array(), $meta_controls = array());

  /**
   * Returns the number of resources available with the given filters.
   *
   * @param array $filters
   *   A list of properties to query for, or an empty array if all resources
   *   should be returned.
   *
   * @return int
   *   The number of resources available.
   */
  public function count($filters = array());

  /**
   * Returns the limit for the current query.
   *
   * @param int $client_limit
   *   The limit specified in the meta controls or NULL if not set.
   *
   * @return int
   *   The limit of the current limit.
   */
  public function limit($client_limit = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
RestWSQueryResourceControllerInterface::count	public	function	Returns the number of resources available with the given filters.	1
RestWSQueryResourceControllerInterface::limit	public	function	Returns the limit for the current query.	1
RestWSQueryResourceControllerInterface::query	public	function	Query for a list of resources.	1
RestWSResourceControllerInterface::access	public	function	Determines access for a given operation and resource.	2
RestWSResourceControllerInterface::create	public	function	Create a new resource.	2
RestWSResourceControllerInterface::delete	public	function	Delete an existing resource.	2
RestWSResourceControllerInterface::propertyInfo	public	function	Returns the property info for the given resource.	2
RestWSResourceControllerInterface::read	public	function	Returns an existing resource.	2
RestWSResourceControllerInterface::resource	public	function	Returns the name of the resource.	2
RestWSResourceControllerInterface::update	public	function	Update an existing resource.	2
RestWSResourceControllerInterface::wrapper	public	function	Returns a metadata wrapper for the resource with the given id.	2