interface FacetapiQueryTypeInterface in Facet API 6.3

Interface that must be implemented by all query type plugins.

Hierarchy

• interface \FacetapiQueryTypeInterface

File

plugins/facetapi/query_type.inc, line 11

Interfaces and base classes for query type plugins.

interface FacetapiQueryTypeInterface {

  /**
   * Returns the query type associated with the plugin.
   *
   * @return string
   *   The query type.
   */
  public static function getType();

  /**
   * Adds the filter to the query object.
   *
   * @param stdClass $query
   *   An object containing the query in the backend's native API.
   */
  public function execute($query);

  /**
   * Initializes the facet's render array.
   *
   * @return
   *   The initialized render array.
   */
  public function build();

}

Members

Name	Modifiers	Type	Description	Overrides
FacetapiQueryTypeInterface::build	public	function	Initializes the facet's render array.	1
FacetapiQueryTypeInterface::execute	public	function	Adds the filter to the query object.	1
FacetapiQueryTypeInterface::getType	public static	function	Returns the query type associated with the plugin.	1