You are here

Home » API reference » Facet API 6.3

facetapi.block.inc in Facet API 6.3

Same filename and directory in other branches
  1. 7.2 facetapi.block.inc
  2. 7 facetapi.block.inc

Block realm code and hook implementations.

File

facetapi.block.inc
View source 
<?php

/**
 * @file
 * Block realm code and hook implementations.
 */
function facetapi_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
      return facetapi_block_info();
      break;
    case 'view':
      return facetapi_block_view($delta);
      break;
  }
}

/**
 * Implements hook_block_info().
 */
function facetapi_block_info() {
  $blocks = array();

  // Gets delta map, iterates over all enabled facets.
  $map = facetapi_get_delta_map();
  foreach (facetapi_get_searcher_info() as $searcher => $info) {

    // Gets cache settings for the searcher.
    $cache = variable_get('facetapi:block_cache:' . $searcher, BLOCK_NO_CACHE);

    // Adds blocks for facets that are enabled or whose delta mapping is forced.
    foreach (facetapi_get_delta_map_queue($searcher, 'block') as $facet_name) {
      if ($facet = facetapi_facet_load($facet_name, $searcher)) {

        // Gets the delta from the delta map.
        $string = facetapi_build_delta($searcher, 'block', $facet_name);
        $delta = array_search($string, $map);

        // Defines the block.
        $blocks[$delta] = array(
          'info' => 'Facet API: ' . $info['label'] . ' : ' . $facet['label'],
          'cache' => $cache,
        );
      }
    }
  }

  // Returns available blocks.
  return $blocks;
}

/**
 * Implements hook_block_list_alter().
 *
 * Parses delta information, checks whether to display block.
 */
function facetapi_block_list_alter(&$blocks) {
  foreach ($blocks as $bid => $block) {
    if ('facetapi' == $block->module) {
      if (!facetapi_check_block_visibility($block->delta)) {
        unset($blocks[$bid]);
      }
    }
  }
}

/**
 * Implements hook_block_view().
 */
function facetapi_block_view($delta = '') {
  $builds =& ctools_static(__FUNCTION__, array());
  $parsed =& ctools_static('facetapi_parsed_deltas', array());

  // Test block visibility if not already tested. This is necessary when using
  // modules such as Context that do not invoke hook_block_list_alter().
  if (!isset($parsed[$delta]) && !facetapi_check_block_visibility($delta)) {
    return;
  }
  list($searcher, $realm_name, $facet_name) = $parsed[$delta];

  // Builds and caches the entire realm per searcher / realm combination.
  $group = $searcher . ':' . $realm_name;
  if (!isset($builds[$group])) {
    $builds[$group] = facetapi_build_realm($searcher, $realm_name);
  }

  // Returns the individual block.
  if (isset($builds[$group][$facet_name])) {

    // Adds contextual links.
    $builds[$group][$facet_name]['#contextual_links'] = array(
      'facetapi' => array(
        'admin/settings/facetapi',
        array(
          $searcher,
          $realm_name,
          $facet_name,
        ),
      ),
    );

    // Returns the subject and content of the block.
    $variables = array(
      'title' => $builds[$group][$facet_name]['#title'],
      'facet' => $builds[$group][$facet_name],
    );

    // Drupal 6 needs direct output from a theme function so we will have to
    // iterate over the build array and output only what is needed.
    // Could use optimization
    $output = NULL;
    foreach (array_keys($builds[$group][$facet_name]) as $key) {
      if ($key[0] != '#') {
        $output = $builds[$group][$facet_name][$key];
        continue;
      }
    }
    return array(
      'subject' => theme('facetapi_title', $variables),
      'content' => $output,
    );
  }
}

/**
 * Checks whether the block should be displayed.
 *
 * In cases where modules like Context are being used, hook_block_list_alter()
 * is not invoked and we get fatal errors. We have to test whether or not the
 * hook has been invoked and call this function manually otherwise.
 *
 * @param $delta
 *   The block delta.
 *
 * @return
 *   A boolean flagging whether to display this block or not.
 */
function facetapi_check_block_visibility($delta) {
  $map = facetapi_get_delta_map();

  // Store parsed deltas so we only calculate once. This also lets us know
  // whether hook_block_list_alter() was called or not.
  $parsed =& ctools_static('facetapi_parsed_deltas', array());

  // Ensures the delta is mapped.
  if (!isset($map[$delta])) {
    $parsed[$delta] = FALSE;
    return FALSE;
  }

  // Parses the raw delta, extracts variables for code readability.
  $parsed[$delta] = facetapi_parse_delta($map[$delta]);
  list($searcher, $realm_name, $facet_name) = $parsed[$delta];

  // Checks whether block should be displayed.
  if (!facetapi_is_active_searcher($searcher)) {
    return FALSE;
  }
  if (!facetapi_facet_enabled($searcher, $realm_name, $facet_name)) {
    return FALSE;
  }
  if (!($adapter = facetapi_adapter_load($searcher))) {
    return FALSE;
  }
  if ($adapter
    ->suppressOutput($realm_name)) {
    return FALSE;
  }

  // We have facets!
  return TRUE;
}

/**
 * Returns a cached delta map of hashes to names.
 *
 * Sometimes our deltas are longer than 32 chars and need to be passed to hash().
 * Due to the block table's schema, deltas cannot be longer than 32 characters.
 * However, hashes are nasty as CSS IDs, so we can use the map to convert
 * the hashes back to a nicer value in facetapi_preprocess_block().
 *
 * @return
 *   An array containing the delta map.
 */
function facetapi_get_delta_map() {
  $map =& ctools_static(__FUNCTION__);
  if (NULL === $map) {
    if ($data = cache_get('facetapi:delta_map') && !empty($data->data)) {
      $map = $data->data;
    }
    else {
      $map = array();

      // Maps facet deltas.
      foreach (facetapi_get_searcher_info() as $searcher => $info) {
        foreach (facetapi_get_delta_map_queue($searcher, 'block') as $facet_name) {
          $delta = facetapi_build_delta($searcher, 'block', $facet_name);
          $map[facetapi_hash_delta($delta)] = $delta;
        }
      }

      // Caches the map so we don't have to do this repeatedly.
      cache_set('facetapi:delta_map', $map, 'cache', CACHE_TEMPORARY);
    }
  }
  return $map;
}

/**
 * Build a delta from the searcher, realm name, and facet name.
 *
 * @param $searcher
 *   The machine readable name of the searcher.
 * @param $realm_name
 *   The machine readable name of the realm.
 * @param $facet_name
 *   The machine readable name of the facet.
 *
 * @return
 *   A string containing the raw delta.
 */
function facetapi_build_delta($searcher, $realm_name, $facet_name) {
  return $searcher . ':' . $realm_name . ':' . urlencode($facet_name);
}

/**
 * Parses a raw delta into parts.
 *
 * @param $raw_delta
 *   A string containing the raw delta prior to being hashed.
 *
 * @return
 *   An array containing the searcher, realm_name, and facet name in that order.
 */
function facetapi_parse_delta($raw_delta) {
  $parsed = array();

  // Splits by ":", finds each part.
  $parts = explode(':', $raw_delta);
  $facet_name = array_pop($parts);
  $facet_name = rawurldecode($facet_name);
  $realm_name = array_pop($parts);
  $searcher = implode(':', $parts);

  // Returns array with parsed info.
  return array(
    $searcher,
    $realm_name,
    $facet_name,
  );
}

/**
 * Hashing code for deltas.
 *
 * @param $delta
 *   A string containing the delta.
 *
 * @return
 *   The hashed delta value.
 */
function facetapi_hash_delta($delta) {

  // Ensure hashes are URL safe and alpha-numeric.
  // @see http://drupal.org/node/1355270
  $hash = substr(facetapi_hash_base64($delta), 0, 32);
  return strtr($hash, array(
    '-' => '0',
    '_' => '1',
  ));
}

/**
 * Returns facets that are enabled or whose delta mapping is forced.
 *
 * @param $searcher
 *   The machine readable name of the searcher.
 * @param $realm_name
 *   The machine readable name of the realm.
 *
 * @return array
 *   A list of machine readable facet names.
 */
function facetapi_get_delta_map_queue($searcher, $realm_name) {
  static $forced;
  if (NULL === $forced) {
    $forced = module_invoke_all('facetapi_force_delta_mapping');
  }
  $enabled = array_keys(facetapi_get_enabled_facets($searcher, $realm_name));
  if (!isset($forced[$searcher][$realm_name])) {
    $forced[$searcher][$realm_name] = array();
  }

  // Merges enabled facets and facets whose mapping is forced.
  return array_unique(array_merge($enabled, $forced[$searcher][$realm_name]));
}
function facetapi_hash_base64($data) {
  $hash = base64_encode(hash('sha256', $data, TRUE));

  // Modify the hash so it's safe to use in URLs.
  return strtr($hash, array(
    '+' => '-',
    '/' => '_',
    '=' => '',
  ));
}

Functions

Namesort descending Description
facetapi_block @file Block realm code and hook implementations.
facetapi_block_info Implements hook_block_info().
facetapi_block_list_alter Implements hook_block_list_alter().
facetapi_block_view Implements hook_block_view().
facetapi_build_delta Build a delta from the searcher, realm name, and facet name.
facetapi_check_block_visibility Checks whether the block should be displayed.
facetapi_get_delta_map Returns a cached delta map of hashes to names.
facetapi_get_delta_map_queue Returns facets that are enabled or whose delta mapping is forced.
facetapi_hash_base64
facetapi_hash_delta Hashing code for deltas.
facetapi_parse_delta Parses a raw delta into parts.