You are here

abstract public function FacetapiUrlProcessor::getQueryString in Facet API 7.2

Same name and namespace in other branches
  1. 6.3 plugins/facetapi/url_processor.inc \FacetapiUrlProcessor::getQueryString()
  2. 7 plugins/facetapi/url_processor.inc \FacetapiUrlProcessor::getQueryString()

Returns the query string variables for a facet item.

The return array must be able to be passed as the "query" key of the options array passed as the second argument to the url() function. See http://api.drupal.org/api/drupal/includes%21common.inc/function/url/7 for more details.

Parameters

array $facet: The facet definition as returned by facetapi_facet_load().

array $values: An array containing the item's values being added to or removed from the query string dependent on whether or not the item is active.

int $active: An integer flagging whether the item is active or not. 1 if the item is active, 0 if it is not.

Return value

array The query string variables.

1 method overrides FacetapiUrlProcessor::getQueryString()
FacetapiUrlProcessorStandard::getQueryString in plugins/facetapi/url_processor_standard.inc
Implements FacetapiUrlProcessor::getQueryString().

File

plugins/facetapi/url_processor.inc, line 103
Base url processor plugin class.

Class

FacetapiUrlProcessor
Abstract class extended by url processor plugins.

Code

public abstract function getQueryString(array $facet, array $values, $active);