abstract public function FacetapiAdapter::suppressOutput in Facet API 7.2
Same name and namespace in other branches
- 6.3 plugins/facetapi/adapter.inc \FacetapiAdapter::suppressOutput()
- 7 plugins/facetapi/adapter.inc \FacetapiAdapter::suppressOutput()
Returns a boolean flagging whether facets in a realm should be displayed.
Useful, for example, for suppressing sidebar blocks in some cases. Apache Solr Search Integration used this method to prevent blocks from being displayed when the module was configured to render them in the search body on "empty" searches instead of the normal facet location.
@todo It appears that no implementing modules are leveraging this anymore. Let's discuss whether to deprecate this method or even remove it from future versions of Facet API at http://drupal.org/node/1661410.
Parameters
string $realm_name: The machine readable name of the realm.
Return value
boolean A boolean flagging whether to display a given realm.
1 method overrides FacetapiAdapter::suppressOutput()
- FacetapiTestAdapter::suppressOutput in tests/
facetapi_test.plugins.inc - Implements FacetapiAdapter::suppressOutput().
File
- plugins/
facetapi/ adapter.inc, line 187 - Adapter plugin and adapter related classes.
Class
- FacetapiAdapter
- Abstract class extended by Facet API adapters.
Code
public abstract function suppressOutput($realm_name);