You are here

class FacetapiEmptyBehaviorNone in Facet API 7

Same name and namespace in other branches
  1. 6.3 plugins/facetapi/empty_behavior.inc \FacetapiEmptyBehaviorNone
  2. 7.2 plugins/facetapi/empty_behavior.inc \FacetapiEmptyBehaviorNone

Empty behavior plugin that returns an empty array.

This is the default behavior for empty facets. Returning an empty array will prevent the facet from being displayed if it contains no items. For example, if facets are displayed as blocks, the empty array will prevent the block from rendering.

Hierarchy

Expanded class hierarchy of FacetapiEmptyBehaviorNone

2 string references to 'FacetapiEmptyBehaviorNone'
facetapi_facetapi_empty_behaviors in ./facetapi.facetapi.inc
Implements hook_facetapi_empty_behaviors().
hook_facetapi_empty_behaviors in ./facetapi.api.php
Define all empty behavior plugins provided by the module.

File

plugins/facetapi/empty_behavior.inc, line 108
Base empty behavior plugin class and default implementation.

View source
class FacetapiEmptyBehaviorNone extends FacetapiEmptyBehavior {

  /**
   * Implements FacetapiEmptyBehavior::execute().
   */
  public function execute() {
    return array();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FacetapiEmptyBehavior::$configName protected property The machine readable name of facet configuration.
FacetapiEmptyBehavior::$settings protected property An array of facet settings.
FacetapiEmptyBehavior::getDefaultSettings public function Provides default values for the plugin settings. 1
FacetapiEmptyBehavior::settingsForm public function Allows the plugin to add settings to the display form. 1
FacetapiEmptyBehavior::translate public function Helper function for translating strings.
FacetapiEmptyBehavior::__construct public function Constructs a FacetapiEmptyBehavior object. 1
FacetapiEmptyBehaviorNone::execute public function Implements FacetapiEmptyBehavior::execute(). Overrides FacetapiEmptyBehavior::execute