You are here

function facetapi_token_list in Facet API 6.3

Implements hook_token_list().

File

./facetapi.tokens.inc, line 11
Builds placeholder replacement tokens for searches.

Code

function facetapi_token_list() {
  $results = $active = $facet = array();

  // Tokens related to search results and response.
  $results['keys'] = t('Search keywords');
  $results['page-number'] = t('Page number');
  $results['page-limit'] = t('Page limit');
  $results['page-total'] = t('Page total');
  $results['offset'] = t('Offset');
  $results['start-count'] = t('Start count');
  $results['end-count'] = t('End count');
  $results['result-count'] = t('Result count');

  // Tokens related to active facet items.
  $active['active-value'] = t('Mapped value');
  $active['active-value-raw'] = t('Raw value');
  $active['active-pos'] = t('Position');
  $active['facet-label'] = t('Facet label');
  $active['facet-name'] = t('Facet name');

  // Tokens related to a facet.
  $facet['facet-label'] = t('Facet label');
  $facet['facet-name'] = t('Facet name');
  return array(
    'facetapi_results' => $results,
    'facetapi_active' => $active,
    'facetapi_facet' => $facet,
  );
}