/[drupal]/contributions/modules/dynosearcho/dynosearcho.module

Diff of /contributions/modules/dynosearcho/dynosearcho.module

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.2,
Sun Jan 20 17:19:43 2008 UTC
+revision 1.3,
Mon Oct 27 17:21:46 2008 UTC
 Line 1
  <?php
- // $Id: dynosearcho.module,v 1.10 2008/01/20 17:18:23 manello Exp $
+ // $Id: dynosearcho.module,v 1.2 2008/01/20 17:19:43 ultimike Exp $
  /**
   * @file
   * DynoSearcho lets users dynamically search for different types of content.
   *
   * This module allows the site admin to display various blocks on the site that provide
   * a dynamic way to search for content. DynoSearch uses AHAH to display results as the
   * user enters them (similar to Drupal's most-excellent autocomplete feature). Each block
   * can be configured to display a configurable number of results from specific node types.
   */
 Line 22 
 function dynosearcho_help($section) {
      case 'admin/modules#description':
        return t('DynoSearcho provides a dynamic (AHAH) way to search for content by title and tags.');
      case 'admin/help#dynosearcho':
        return t('DynoSearcho provides a dynamic (AHAH) way to search for content.
  This module allows the site admin to display various blocks on the site that provide a dynamic
  way to search for content. DynoSearch uses AHAH to display results as the user enters them
  (similar to Drupal\'s most-excellent autocomplete feature). Each block can be configured
  to display a configurable number of results from <strong>specific node types</strong> as well as the information returned.
  The module only searches title and tags to find matches.
  <br/><br/>
  DynoSearcho is not a replacement for the search module, it is much simpler and doesn\'t search the
  body of the content. It is meant to be a faster, lightweight search agent for quick searches over
  a <strong>limited</strong> set of nodes.
  <br/><br/>
  The site admin can select how many DynoSearcho blocks are available from '. l('DynoSearcho\'s settings page', 'admin/settings/dynosearcho') .'. '.
  'Each block can then be configured from the '. l('Block Configuration Page', 'admin/block') .'.
  <br/><br/>
  The search results are cached on the client to minimize trips back to the server. This is possible
  since much of the JavaScript (JQuery) code was borrowed from the autocomplete module.
  <br/><br/>
  Each DynoSearcho block has extensive configuration settings from the block administration page. DynoSearcho
  also integrates nicely with the standard Drupal search. If this option is selected in the block configuration,
  a user can enter some terms into the DynoSearcho box and press the "enter" key to submit their
  search query to the full Drupal search system.
  <br/><br/>
  Finally, the module uses unobtrusive JavaScript. When JavaScript is not available, a "search" button is
  present and the search results are shown on a new page (after a round-trip to the server, of course).
  <br/><br/>
  ');
 Line 56 
 present and the search results are shown
   */
  function dynosearcho_menu($may_cache) {
    $items = array();
    if ($may_cache) {
      $items[] = array(
          'title' => 'DynoSearcho',
 Line 67 
 function dynosearcho_menu($may_cache) {
          'access' => user_access('administer site configuration'),
          'type' => MENU_NORMAL_ITEM,
      );
    }
    else {
      $items[] = array(
          'description' => 'Perform a DynoSearch search.',
 Line 96 
 function dynosearcho_block($op = 'list',
        $blocks[$i] = array('info' => t('DynoSearcho block #') . (string)($i + 1));
      }
      return $blocks;
    }
    elseif ($op == 'configure') {
      return dynosearcho_block_settings_form($delta);
 Line 121 
 function dynosearcho_block($op = 'list',
  }
  function dynosearcho_block_settings_form($delta) {
    drupal_add_js(drupal_get_path('module', 'dynosearcho') .'/dynosearcho.js');
    $form['search_box_title'] = array(
      '#type' => 'textfield',
      '#title' => t('Search box title'),
 Line 130 
 function dynosearcho_block_settings_form
      '#maxlength' => 50,
      '#description' => t('This text will be the title of the actual search box.'),
    );
    $form['results_returned'] = array(
      '#type' => 'select',
      '#title' => t('Number of results returned'),
 Line 147 
 function dynosearcho_block_settings_form
      ),
      '#description' => t('The higher the value, the slower the response.'),
    );
    $form['integrated_search'] = array(
      '#type' => 'checkbox',
      '#title' => t('Integrated with Drupal\'s standard search'),
      '#default_value' => variable_get('dynosearcho_integrated_search_'. $delta, '0'),
      '#description' => t('If selected, when the presses the "enter" key, the search terms in the DynoSearch box will be submitted to the standard Drupal search module.'),
    );
    if (!module_exists('search')) {
      $form['integrated_search']['#value'] = 0;
      $form['integrated_search']['#disabled'] = true;
      $form['integrated_search']['#description'] = t('The search module must be enabled for this option to be available.');
    }
    $form['header'] = array(
      '#type' => 'textfield',
      '#title' => t('Header'),
 Line 168 
 function dynosearcho_block_settings_form
      '#maxlength' => 250,
      '#description' => t('This text will be displayed above the search box.'),
    );
    $form['results_info_text'] = array(
      '#type' => 'textfield',
      '#title' => t('Results Info Text'),
 Line 176 
 function dynosearcho_block_settings_form
      '#maxlength' => 250,
      '#description' => t('This is the text that will be shown to the user when the number of results is greater than the Number of Results Returned field above. %totalmatches and %resultsreturned wild cards available.'),
    );
    $form['no_results'] = array(
      '#type' => 'textfield',
      '#title' => t('No Results Text'),
 Line 184 
 function dynosearcho_block_settings_form
      '#maxlength' => 250,
      '#description' => t('This is the text that will be shown if there are no results to be displayed.'),
    );
    $form['search_type'] = array(
      '#type' => 'radios',
      '#title' => t('Search Type'),
      '#default_value' => variable_get('dynosearcho_search_type_'. $delta, 'node'),
      '#options' => array(
                      'node' => t('node'),
                      'menu' => t('menu')
                    ),
      '#description' => t('Select the type of search this DynoSearcho block will perform.'),
      '#attributes' => array('class' => 'dynosearcho_searchtype'),
    );
    $form['node_search'] = array(
      '#type' => 'fieldset',
      '#title' => 'Node Search Settings',
 Line 204 
 function dynosearcho_block_settings_form
      '#collapsible' => false,
      '#attributes' => array('id' => 'dynosearcho_nodesearch'),
    );
    $form['node_search']['searchable_node_types'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Node types to search'),
 Line 212 
 function dynosearcho_block_settings_form
      '#options' => node_get_types('names'),
      '#description' => t('The more nodes types selected, the slower the response.'),
    );
    $form['node_search']['display_relevant_tags'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display relevant tags in results'),
      '#default_value' => variable_get('dynosearcho_display_relevant_tags_'. $delta, '1'),
      '#description' => t('If selected, tags that match search query will be displayed next to the title of the content returned.'),
    );
    $form['node_search']['teaser_length'] = array(
      '#type' => 'select',
      '#title' => t('Length of teaser displayed'),
 Line 234 
 function dynosearcho_block_settings_form
      ),
      '#description' => t('HTML tags will be automatically stripped out of teaser content.'),
    );
    $form['node_search']['sort_by_date'] = array(
      '#type' => 'checkbox',
      '#title' => t('Sort results by last modified date.'),
      '#default_value' => variable_get('dynosearcho_sort_by_date_'. $delta, '0'),
      '#description' => t('Displays most recent first. Overrides default sort order of alphabetically by node title.'),
    );
    $form['node_search']['display_edit_links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display edit links'),
      '#default_value' => variable_get('dynosearcho_display_edit_links_'. $delta, '0'),
      '#description' => t('This will display edit links for nodes returned in the search results providing that the user has the "administer nodes" permission.'),
    );
    $form['node_search']['use_og_desc'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use Organic Groups description field for teaser text.'),
      '#default_value' => variable_get('dynosearcho_use_og_desc_'. $delta, '0'),
      '#description' => t('This will replace the teaser text with the Organic Groups description. <strong>This should only be checked if the DynoSearcho box is only going to be searching groups.</strong>'),
    );
    $form['menu_search'] = array(
      '#type' => 'fieldset',
      '#title' => 'Menu Search Settings',
 Line 263 
 function dynosearcho_block_settings_form
      '#collapsible' => false,
      '#attributes' => array('id' => 'dynosearcho_menusearch'),
    );
    $form['menu_search']['display_menu_paths'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display menu paths in results'),
 Line 283 
 function _dynosearcho_settings() {
    );
    return system_settings_form($form);
  }
  function dynosearcho_search_form($delta, $matches = NULL) {
    drupal_add_js(drupal_get_path('module', 'dynosearcho') .'/dynosearcho.js');
    drupal_add_css(drupal_get_path('module', 'dynosearcho') .'/dynosearcho.css');
    $form['#id'] = 'dynosearcho_search_form_' . $delta;
    $form['#attributes'] = array('class' => 'dynosearcho');
    if (variable_get('dynosearcho_integrated_search_'. $delta, '0')) {
      $form['dynosearcho_integrated_search_'. $delta] = array(
        '#type' => 'hidden',
 Line 299 
 function dynosearcho_search_form($delta,
      );
    }
    if (!module_exists('search')) $form['dynosearcho_integrated_search_'. $delta]['#value'] = 0;
    $form['header'] = array(
      '#value' => variable_get('dynosearcho_header_'. $delta, 'Enter keywords to begin.'),
    );
    if ((arg(0) == 'dynosearcho') && (arg(3) == '1')) {
      $default_value = arg(2);
    }
 Line 311 
 function dynosearcho_search_form($delta,
      '#type' => 'textfield',
      '#title' => variable_get('dynosearcho_search_box_title_'. $delta, 'Keywords'),
      '#description' => t('Use commas to separate multiple keywords.'),
      '#maxlength' => 60,
      '#size' => 10,
      '#default_value' => $default_value,
      '#attributes' => array('class' => 'dynosearcho_searchbox'),
    );
    $form['dynosearcho_delta'] = array(
      '#type' => 'hidden',
      '#value' => $delta,
    );
    $form['dynosearcho_url_'. $delta] = array(
      '#type' => 'hidden',
      '#value' => url('dynosearcho'),
    );
    $form['dynosearcho_basepath_'. $delta] = array(
      '#type' => 'hidden',
      '#value' => base_path(),
      '#attributes' => array('class' => 'dynosearcho_basepath'),
    );
    $form['dynosearcho_results_' . $delta] = array(
      '#value' => '<div class="dynosearcho_results" id="dynosearcho_results_' . $delta . '">' . $matches . '</div>',
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Search')
    );
    return $form;
  }
 Line 354 
 function dynosearcho_search_form_submit(
  function dynosearcho_dosearch($delta = 0, $string, $whole_page = false) {
    // separate out multiple keywords if necessary
    $keywords = explode(',', $string);
    switch (variable_get('dynosearcho_search_type_'. $delta, 'node')) {
      case 'node':
        return dynosearcho_nodesearch($delta, $keywords, $whole_page);
 Line 371 
 function _dynosearcho_menu_search_preg($
      foreach ($in_array as $key => $val) {
        if (is_array($val)) {
          $keys_found = _dynosearcho_menu_search_preg($find, $val, $keys_found);
        }
        else {
          if (preg_match('/'. $find .'/i', $val)) {
            $keys_found[] = $theitem;
 Line 384 
 function _dynosearcho_menu_search_preg($
  }
  //----- Thanks to a.fotoglidis (http://us2.php.net/manual/en/function.array-unique.php#68339) for this function
  function _dynosearcho_menu_elim_dups($array, $row_element) {
    $new_array[0] = $array[0];
    foreach ($array as $current) {
      $add_flag = 1;
 Line 401 
 function _dynosearcho_menu_elim_dups($ar
  function dynosearcho_menusearch($delta, $keywords, $whole_page) {
    // build one query for each keyword, then run and merge the results
    $rawmatches = array();
    $menu = menu_get_menu();
    foreach ($keywords as $keyword) {
      $keyword = trim($keyword);
      $rawmatches = _dynosearcho_menu_search_preg($keyword, $menu['visible'], $rawmatches);
 Line 419 
 function dynosearcho_menusearch($delta,
      }
      $matches[] = $item;
    }
    //----- get the total number of matches for display
    $total_matches = count($matches);
    // only return the desired number of matches - this has to be done here and not with db_query_range because of array_intersect_key stuff
 Line 435 
 function dynosearcho_menusearch($delta,
      $array_text['title'] = '<span class="dynosearcho_info">'. strtr($temp, $variables) .'</span>';
      $matches[] = $array_text;
    }
    if (!$whole_page) {
      $jsoutput = array();
      foreach ($matches as $match) {
 Line 462 
 function dynosearcho_nodesearch($delta,
    // build one query for each keyword, then run and merge the results
    $matches = array();
    if (user_access('access content')) {
-     $sql = "SELECT DISTINCT n.nid, n.changed, ";
+     $sql = "SELECT DISTINCT n.nid, n.changed, r.format, ";
      if (variable_get('dynosearcho_display_relevant_tags_'. $delta, '1')) {
        $sql .= "td.name, ";
      }
 Line 471 
 function dynosearcho_nodesearch($delta,
        $breakpoints = array('</p>' => 4, '<br />' => 0, '<br>' => 0, "\n" => 0, '. ' => 1, '! ' => 1, '? ' => 1, '。' => 3, '؟ ' => 1);
        if (variable_get('dynosearcho_use_og_desc_'. $delta, '0')) {
          $sql .= "og.description AS teaser, ";
        }
        else {
          $sql .= "r.teaser AS teaser, ";
        }
 Line 510 
 function dynosearcho_nodesearch($delta,
                }
              }
            }
-           $item['teaser'] = $node->teaser;
+           $item['teaser'] = check_markup($node->teaser, $node->format, FALSE);
          }
          $tempmatches[$node->nid] = $item;
        }
        // this effectively provides the logical "and" for multiple keywords
        if (count($matches)) {
          $matches = array_intersect_key($matches, $tempmatches);
        }
        else {
          $matches = $tempmatches;
        }
        // this sorts the matches
        if (variable_get('dynosearcho_sort_by_date_'. $delta, '0')) {
          uasort($matches, "_dynosearcho_datemod_compare");
        }
        else {
          asort($matches);
        }
        //----- get the total number of matches for display
        $total_matches = count($matches);
        // only return the desired number of matches - this has to be done here and not with db_query_range because of array_intersect_key stuff
 Line 558 
 function dynosearcho_nodesearch($delta,
      }
      print drupal_to_js($jsoutput);
      exit();
    }
    else {
      $output = theme('dynosearcho_results', $matches);
      return drupal_get_form('dynosearcho_search_form', $delta, $output);

 Legend:



Removed from v.1.2
 


changed lines


 
Added in v.1.3
 Legend:



Removed from v.1.2
 


changed lines


 
Added in v.1.3
-Removed from v.1.2
+Added in v.1.3

	ViewVC Help
Powered by ViewVC 1.1.2