search.views.inc in Views (for Drupal 7) 7.3

Provide views data and handlers for search.module.

File

modules/search.views.inc

<?php

/**
 * @file
 * Provide views data and handlers for search.module.
 *
 * @ingroup views_module_handlers
 */

/**
 * Implements hook_views_data().
 */
function search_views_data() {

  // Basic table information.
  // Define the base group of this table. Fields that don't have a group
  // defined will go into this field by default.
  $data['search_index']['table']['group'] = t('Search');

  // For other base tables, explain how we join.
  $data['search_index']['table']['join'] = array(
    'node' => array(
      'left_field' => 'nid',
      'field' => 'sid',
    ),
  );
  $data['search_total']['table']['join'] = array(
    'node' => array(
      'left_table' => 'search_index',
      'left_field' => 'word',
      'field' => 'word',
    ),
    'users' => array(
      'left_table' => 'search_index',
      'left_field' => 'word',
      'field' => 'word',
    ),
  );
  $data['search_dataset']['table']['join'] = array(
    'node' => array(
      'left_table' => 'search_index',
      'left_field' => 'sid',
      'field' => 'sid',
      'extra' => array(
        'search_index.type = search_dataset.type',
      ),
      'type' => 'INNER',
    ),
    'users' => array(
      'left_table' => 'search_index',
      'left_field' => 'sid',
      'field' => 'sid',
      'extra' => array(
        'search_index.type = search_dataset.type',
      ),
      'type' => 'INNER',
    ),
  );

  // ----------------------------------------------------------------
  // Fields.
  // Score.
  $data['search_index']['score'] = array(
    'title' => t('Score'),
    'help' => t('The score of the search item. This will not be used if the search filter is not also present.'),
    'field' => array(
      'handler' => 'views_handler_field_search_score',
      'click sortable' => TRUE,
      'float' => TRUE,
      'no group by' => TRUE,
    ),
    // Information for sorting on a search score.
    'sort' => array(
      'handler' => 'views_handler_sort_search_score',
      'no group by' => TRUE,
    ),
  );

  // Search node links: forward links.
  $data['search_node_links_from']['table']['group'] = t('Search');
  $data['search_node_links_from']['table']['join'] = array(
    'node' => array(
      'arguments' => array(
        'search_node_links',
        'node',
        'nid',
        'nid',
        NULL,
        'INNER',
      ),
    ),
  );
  $data['search_node_links_from']['sid'] = array(
    'title' => t('Links from'),
    'help' => t('Other nodes that are linked from the node.'),
    'argument' => array(
      'handler' => 'views_handler_argument_node_nid',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_equality',
    ),
  );

  // Search node links: backlinks.
  $data['search_node_links_to']['table']['group'] = t('Search');
  $data['search_node_links_to']['table']['join'] = array(
    'node' => array(
      'arguments' => array(
        'search_node_links',
        'node',
        'nid',
        'sid',
        NULL,
        'INNER',
      ),
    ),
  );
  $data['search_node_links_to']['nid'] = array(
    'title' => t('Links to'),
    'help' => t('Other nodes that link to the node.'),
    'argument' => array(
      'handler' => 'views_handler_argument_node_nid',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_equality',
    ),
  );

  // Search filter.
  $data['search_index']['keys'] = array(
    // The item it appears as on the UI,
    'title' => t('Search Terms'),
    // The help that appears on the UI,
    'help' => t('The terms to search for.'),
    // Information for searching terms using the full search syntax.
    'filter' => array(
      'handler' => 'views_handler_filter_search',
      'no group by' => TRUE,
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_search',
      'no group by' => TRUE,
    ),
  );
  return $data;
}

/**
 * Implements hook_views_plugins().
 */
function search_views_plugins() {
  return;

  // DISABLED. This currently doesn't work.
  // @todo Fix this.
  return array(
    'module' => 'views',
    // This just tells our themes are elsewhere.
    'row' => array(
      'search' => array(
        'title' => t('Search'),
        'help' => t('Display the results with standard search view.'),
        'handler' => 'views_plugin_row_search_view',
        'theme' => 'views_view_row_search',
        'path' => drupal_get_path('module', 'views') . '/modules/search',
        // Not necessary for most modules.
        'base' => array(
          'node',
        ),
        // Only works with 'node' as base.
        'type' => 'normal',
      ),
      'views_handler_argument_search' => array(
        'parent' => 'views_handler_argument',
      ),
    ),
  );
}

/**
 * Template helper for theme_views_view_row_search.
 */
function template_preprocess_views_view_row_search(&$vars) {
  $vars['node'] = '';

  // Make sure var is defined.
  $nid = $vars['row']->nid;
  if (!is_numeric($nid)) {
    return;
  }

  // @todo Once the search row is fixed this node_load should be replace by a
  // node_load_multiple().
  $node = node_load($nid);
  if (empty($node)) {
    return;
  }

  // Build the node body.
  $node = node_build_content($node, FALSE, FALSE);
  $node->body = drupal_render($node->content);

  // Fetch comments for snippet.
  $node->body .= module_invoke('comment', 'nodeapi', $node, 'update index');

  // Fetch terms for snippet.
  $node->body .= module_invoke('taxonomy', 'nodeapi', $node, 'update index');
  $vars['url'] = url('node/' . $nid);
  $vars['title'] = check_plain($node->title);
  $info = array();
  $info['type'] = node_type_get_name($node);
  $info['user'] = theme('username', array(
    'acccount' => $node,
  ));
  $info['date'] = format_date($node->changed, 'small');
  $extra = module_invoke_all('node_search_result', $node);
  if (isset($extra) && is_array($extra)) {
    $info = array_merge($info, $extra);
  }
  $vars['info_split'] = $info;
  $vars['info'] = implode(' - ', $info);
  $vars['node'] = $node;

  // @todo Where does the score come from?
  // $vars['score'] = $item->score;
  $vars['snippet'] = search_excerpt($vars['view']->value, $node->body);
}

Related topics

Views module handlers

Handlers exposed by various modules to Views.

Functions

Name	Description
search_views_data	Implements hook_views_data().
search_views_plugins	Implements hook_views_plugins().
template_preprocess_views_view_row_search	Template helper for theme_views_view_row_search.