Source for file helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Search
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * Helper class for Joomla! Search components
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Search
  17.  * @since       3.0
  18.  */
  19. class JSearchHelper
  20. {
  21.     /**
  22.      * Method to log search terms to the database
  23.      *
  24.      * @param   string  $term       The term being searched
  25.      * @param   string  $component  The component being used for the search
  26.      *
  27.      * @return  void 
  28.      *
  29.      * @since   3.0
  30.      */
  31.     public static function logSearch($term, $component)
  32.     {
  33.         // Initialise our variables
  34.         $db = JFactory::getDbo();
  35.         $query = $db->getQuery(true);
  36.         $enable_log_searches = JComponentHelper::getParams($component)->get('enabled');
  37.  
  38.         // Sanitise the term for the database
  39.         $search_term = $db->escape(trim(strtolower($term)));
  40.  
  41.         if ($enable_log_searches)
  42.         {
  43.             // Query the table to determine if the term has been searched previously
  44.             $query->select($db->quoteName('hits'))
  45.                 ->from($db->quoteName('#__core_log_searches'))
  46.                 ->where($db->quoteName('search_term') . ' = ' . $db->quote($search_term));
  47.             $db->setQuery($query);
  48.             $hits = intval($db->loadResult());
  49.  
  50.             // Reset the $query object
  51.             $query->clear();
  52.  
  53.             // Update the table based on the results
  54.             if ($hits)
  55.             {
  56.                 $query->update($db->quoteName('#__core_log_searches'))
  57.                     ->set('hits = (hits + 1)')
  58.                     ->where($db->quoteName('search_term') . ' = ' . $db->quote($search_term));
  59.             }
  60.             else
  61.             {
  62.                 $query->insert($db->quoteName('#__core_log_searches'))
  63.                     ->columns(array($db->quoteName('search_term'), $db->quoteName('hits')))
  64.                     ->values($db->quote($search_term) . ', 1');
  65.             }
  66.  
  67.             // Execute the update query
  68.             $db->setQuery($query);
  69.             $db->execute();
  70.         }
  71.     }
  72. }

Documentation generated on Tue, 19 Nov 2013 15:04:31 +0100 by phpDocumentor 1.4.3