You are here

Home » API reference » Facet API 7.2 » widget.inc » FacetapiWidget

protected property FacetapiWidget::$key in Facet API 7.2

Same name and namespace in other branches
  1. 6.3 plugins/facetapi/widget.inc \FacetapiWidget::key
  2. 7 plugins/facetapi/widget.inc \FacetapiWidget::key

The key of the facet's render array added to the realm's render array.

After the render array is acted on by FacetapiWidget::execute(), it is retrieved by FacetapiWidget::getBuild() and appended to the realm's render array using this key as the element name. The default key is the "field alias" in the facet's definition.

Type: string

See also

FacetapiFacet::build()

FacetapiAdapter::buildRealm()

File

plugins/facetapi/widget.inc, line 73
Base widget plugin class and helper functions for facet sorting.

Class

FacetapiWidget
Abstract class extended by widget plugins.

Code

protected $key;