google_appliance.api.php in Google Search Appliance 7

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

File

google_appliance.api.php

<?php

/**
 * @file
 * This file contains no working PHP code; it exists to provide additional
 * documentation for doxygen as well as to document hooks in the standard
 * Drupal manner.
 */

/**
 * @defgroup google_appliance Google Search Appliance module integrations.
 *
 * Module integrations with the Google Search Appliance module.
 */

/**
 * @defgroup google_appliance_hooks Google Search Appliance's hooks
 * @{
 * Hooks that can be implemented by other modules in order to extend the Google
 * Search Appliance module.
 */

/**
 * Alter Google Search Appliance queries.
 *
 * This hook is invoked after Google Search Appliance builds the query, just
 * before the query is sent to the appliance.
 *
 * Use this to alter which collection is queried, which frontend is used, add
 * meta tag constraints, restrict queries to specific languages, etc. A complete
 * list of search parameters is available in the Google developer documentation
 * referenced below.
 *
 * @param $query
 *   The search query, represented as multi-dimensional, associative array just
 *   before it is sent to the search appliance.
 *
 * @see google_appliance_search_view()
 * @see https://developers.google.com/search-appliance/documentation/614/xml_reference#request_parameters
 */
function hook_google_appliance_query_alter(&$query) {

  // Only return English language results.
  $query['gsa_query_params']['lr'] = 'en';

  // Alter the appliance host.
  $query['gsa_host'] = 'http://gsa.example.com';
}

/**
 * Alter cURL request sent to Google Search Appliance.
 *
 * This hook is invoked after Google Search Appliance builds the query, just
 * before the query is sent to the appliance.
 *
 * Use this to alter options of the cURL request.
 *
 * @param $options
 *   The cURL options, represented as multi-dimensional, associative array just
 *   before it is sent to the search appliance.
 *
 * @see google_appliance_search_view()
 * @see http://www.php.net/manual/en/function.curl-setopt.php
 */
function hook_google_appliance_curl_alter(&$options) {

  // Enable verbose logging to STDERR.
  $options[CURLOPT_VERBOSE] = TRUE;

  // Set HTTP proxy to tunnel requests through.
  $options[CURLOPT_PROXY] = 'http://gsa-proxy.example.com';
}

/**
 * Alter Google Search Appliance results.
 *
 * This hook is invoked after the search appliance returns with a response and
 * the Google Search Appliance module does its basic parsing.
 *
 * Use this to make result alterations that are inappropriate at the theme
 * level.
 *
 * @param $results
 *   The search results, represented as a multi-dimensional associative array.
 *
 * @param $payload
 *   The XML returned by the search appliance as a SimpleXMLElement object.
 *   Although this is alterable, it's unlikely you will want to make changes to
 *   the XML payload.
 *
 * @see google_appliance_parse_device_response_xml()
 */
function hook_google_appliance_results_alter(&$results, &$payload) {

  // Simple example: alter all titles returned in the result set.
  foreach ($results['entry'] as &$result) {
    $result['title'] = str_replace('foo', 'bar', $result['title']);
  }

  // Advanced example: parse and return onebox results from the payload.
  foreach ($payload
    ->xpath('//OBRES') as $onebox) {

    // Code to parse each onebox here.
    $ob_return = array(
      'foo' => 'bar',
      'baz' => array(),
    );

    // Add the onebox to the results array.
    $results['oneboxes'][] = $ob_return;
  }
}

/**
 * Alter the cluster list render array containing related searches.
 *
 * This hook is invoked after the list render array is constructed and just
 * before it is passed to drupal_render().
 *
 * Use this to alter the render array properties.
 *
 * @param $cluster_list
 *   A renderable array conforming to theme_item_list().
 *
 * @param $cluster_results
 *   The raw cluster results returned via the Google Appliance instance.
 *
 * @see google_appliance_get_clusters()
 * @see theme_item_list()
 */
function hook_google_appliance_cluster_list_alter(&$cluster_list, $cluster_results) {

  // Add some CSS classes.
  $cluster_list['#attributes']['class'][] = 'foo-list';

  // Construct a new list of links using the raw results with a custom path.
  foreach ($cluster_results as $ind => $cluster) {
    $items[] = l($cluster['label'], 'search/my/path/' . $cluster['label']);
  }
  $cluster_list['#items'] = $items;

  // Change the first item of the list.
  $cluster_list['#items'][0] = '<span>A new item</span>';
}

/**
 * @}
 */

Functions

Name	Description
hook_google_appliance_cluster_list_alter	Alter the cluster list render array containing related searches.
hook_google_appliance_curl_alter	Alter cURL request sent to Google Search Appliance.
hook_google_appliance_query_alter	Alter Google Search Appliance queries.
hook_google_appliance_results_alter	Alter Google Search Appliance results.