You are here

Home » API reference » Facet API 7 » facetapi.module

function facetapi_save_facet_disabled in Facet API 7

Same name and namespace in other branches
  1. 6.3 facetapi.module \facetapi_save_facet_disabled()
  2. 7.2 facetapi.module \facetapi_save_facet_disabled()

Disables a facet in a given realm, stores settings in the database.

@reutrn bool TRUE if the operation succeeded, FALSE otherwise.

Parameters

FacetapiAdapter $adapter: The adapter object of the searcher the settings are being modified for.

array $realm: The realm definition as returned by facetapi_realm_load().

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

bool $weight: If the realm is sortable, allows the assigning of a weight. Pass FALSE to maintain the previously stored value.

bool $batch_process: A boolean flagging whether batch processing is being performed.

1 call to facetapi_save_facet_disabled()
FacetapiApiFunctions::testSaveFacetStatus in tests/facetapi.test
Tests facetapi_save_facet_status() API functions.

File

./facetapi.module, line 1224
An abstracted facet API that can be used by various search backends.

Code

function facetapi_save_facet_disabled(FacetapiAdapter $adapter, array $realm, array $facet, $weight = FALSE, $batch_process = FALSE) {
  return facetapi_save_facet_status($adapter, $realm, $facet, FALSE, $weight, $batch_process);
}