class FacetapiWidgetCheckboxLinks in Facet API 6.3

Widget that renders facets as a list of clickable checkboxes.

Hierarchy

• class \FacetapiWidget
  • class \FacetapiWidgetLinks
    • class \FacetapiWidgetCheckboxLinks

1 string reference to 'FacetapiWidgetCheckboxLinks'

facetapi_facetapi_widgets in ./facetapi.facetapi.inc

File

plugins/facetapi/widget_links.inc, line 210

Widgets for facets rendered as links.

class FacetapiWidgetCheckboxLinks extends FacetapiWidgetLinks {

  /**
   * Adds JavaScript settings.
   */
  public function init() {
    parent::init();
    $this->jsSettings['makeCheckboxes'] = 1;
  }

  /**
   * Sets the base class for checkbox facet items.
   *
   * @return array
   *   An array of classes.
   */
  public function getItemClasses() {
    return array(
      'facetapi-checkbox',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetapiWidget::$build	protected	property	The normalized render array.
FacetapiWidget::$facet	protected	property	The facet object.
FacetapiWidget::$id	protected	property	The machine readable name of the widget.
FacetapiWidget::$jsSettings	protected	property	JavaScript settings.
FacetapiWidget::$key	protected	property	The key of the facet's render array added to the realm's render array.
FacetapiWidget::$realm	protected	property	The realm definition.
FacetapiWidget::$settings	protected	property	The facet settings.
FacetapiWidget::applySorts	protected	function	Sorts the facet's build array.
FacetapiWidget::getBuild	public	function	Returns the render array.
FacetapiWidget::getId	public	function	Returns the machine readable name of the widget.
FacetapiWidget::getJavaScriptSettings	public	function	Returns the JavaScript settings.
FacetapiWidget::getKey	public	function	Returns the element's key value.
FacetapiWidget::sortCallback	protected	function	Generic sort callback, useful as a callback to uasort().
FacetapiWidget::sortFacet		function	Applies selected sorting algorithms to the render array.
FacetapiWidgetCheckboxLinks::getItemClasses	public	function	Sets the base class for checkbox facet items. Overrides FacetapiWidgetLinks::getItemClasses
FacetapiWidgetCheckboxLinks::init	public	function	Adds JavaScript settings. Overrides FacetapiWidget::init
FacetapiWidgetLinks::buildListItems		function	Recursive function that converts the render array into an array that can be passed to theme_item_list().
FacetapiWidgetLinks::execute	public	function	Renders the links. Overrides FacetapiWidget::execute
FacetapiWidgetLinks::getDefaultSettings		function	Returns defaults for the settings this widget provides. Overrides FacetapiWidget::getDefaultSettings
FacetapiWidgetLinks::setThemeHooks	protected	function	Recursive function that sets each item's theme hook.
FacetapiWidgetLinks::settingsForm		function	Adds the soft limit setting. Overrides FacetapiWidget::settingsForm
FacetapiWidgetLinks::__construct	public	function	Overrides constructor to reset the key. Overrides FacetapiWidget::__construct