function facetapi_facetapi_realm_info in Facet API 6

Same name and namespace in other branches

1. 6.3 facetapi.facetapi.inc \facetapi_facetapi_realm_info()
2. 7.2 facetapi.facetapi.inc \facetapi_facetapi_realm_info()
3. 7 facetapi.facetapi.inc \facetapi_facetapi_realm_info()

Implementation of hook_facetapi_realm_info().

File

./facetapi.module, line 1437

An abstracted facet API that can be used by various search backens.

Code

function facetapi_facetapi_realm_info() {
  $realms = array();

  // Displays each facet in a separate block.
  $realms['block'] = array(
    'title' => t('Blocks'),
    'weight' => -10,
    'sortable' => FALSE,
    'default widget' => 'facetapi_links',
    'widget requirements' => array(
      'list',
    ),
    'description' => t('The <em>Blocks</em> realm displays each facet in a separate <a href="@block-page">block</a>. Users are able to refine their searches in a drill-down fassion similar to the Apache Solr Search Integration module\'s faceted search implementation.', array(
      '@block-page' => url('admin/build/block/list', array(
        'query' => array(
          'destination' => $_GET['q'],
        ),
      )),
    )),
  );

  // Displays facets in a fieldset below the search form.
  $realms['fieldset'] = array(
    'title' => t('Fieldset'),
    'weight' => -5,
    'default widget' => 'facetapi_textfield',
    'widget requirements' => array(
      'form',
    ),
    'description' => t('The <em>Fieldset</em> realm displays facets as form elements in a fieldset below the search form that is similar in appearance to the core Search module\'s <em>Advanced search</em> fieldset.'),
  );
  return $realms;
}