Source for file searches.php

Documentation is available at searches.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_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('_JEXEC') or die;
  11.  
  12. /**
  13.  * Methods supporting a list of search terms.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_search
  17.  * @since       1.6
  18.  */
  19. class SearchModelSearches extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  An optional associative array of configuration settings.
  25.      * @see     JController
  26.      * @since   1.6
  27.      */
  28.     public function __construct($config = array())
  29.     {
  30.         if (empty($config['filter_fields']))
  31.         {
  32.             $config['filter_fields'] = array(
  33.                 'search_term', 'a.search_term',
  34.                 'hits', 'a.hits',
  35.             );
  36.         }
  37.  
  38.         parent::__construct($config);
  39.     }
  40.  
  41.     /**
  42.      * Method to auto-populate the model state.
  43.      *
  44.      * Note. Calling getState in this method will result in recursion.
  45.      *
  46.      * @param   string  $ordering   An optional ordering field.
  47.      * @param   string  $direction  An optional direction (asc|desc).
  48.      *
  49.      * @return  void 
  50.      *
  51.      * @since   1.6
  52.      */
  53.     protected function populateState($ordering = null, $direction = null)
  54.     {
  55.         // Load the filter state.
  56.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search', false, 'string', false);
  57.         $this->setState('filter.search', $search);
  58.  
  59.         $showResults = $this->getUserStateFromRequest($this->context . '.filter.results', 'filter_results', null, 'int', false);
  60.         $this->setState('filter.results', $showResults);
  61.  
  62.         // Load the parameters.
  63.         $params = JComponentHelper::getParams('com_search');
  64.         $this->setState('params', $params);
  65.  
  66.         // List state information.
  67.         parent::populateState('a.hits', 'asc');
  68.     }
  69.  
  70.     /**
  71.      * Method to get a store id based on model configuration state.
  72.      *
  73.      * This is necessary because the model is used by the component and
  74.      * different modules that might need different sets of data or different
  75.      * ordering requirements.
  76.      *
  77.      * @param   string  $id    A prefix for the store id.
  78.      *
  79.      * @return  string  A store id.
  80.      * @since   1.6
  81.      */
  82.     protected function getStoreId($id = '')
  83.     {
  84.         // Compile the store id.
  85.         $id .= ':' . $this->getState('filter.search');
  86.         $id .= ':' . $this->getState('filter.results');
  87.  
  88.         return parent::getStoreId($id);
  89.     }
  90.  
  91.     /**
  92.      * Build an SQL query to load the list data.
  93.      *
  94.      * @return  JDatabaseQuery 
  95.      * @since   1.6
  96.      */
  97.     protected function getListQuery()
  98.     {
  99.         // Create a new query object.
  100.         $db = $this->getDbo();
  101.         $query = $db->getQuery(true);
  102.  
  103.         // Select the required fields from the table.
  104.         $query->select(
  105.             $this->getState(
  106.                 'list.select',
  107.                 'a.*'
  108.             )
  109.         );
  110.         $query->from($db->quoteName('#__core_log_searches') . ' AS a');
  111.  
  112.         // Filter by access level.
  113.         if ($access = $this->getState('filter.access'))
  114.         {
  115.             $query->where('a.access = ' . (int) $access);
  116.         }
  117.  
  118.         // Filter by search in title
  119.         $search = $this->getState('filter.search');
  120.         if (!empty($search))
  121.         {
  122.             $search = $db->quote('%' . $db->escape($search, true) . '%');
  123.             $query->where('a.search_term LIKE ' . $search);
  124.         }
  125.  
  126.         // Add the list ordering clause.
  127.         $query->order($db->escape($this->getState('list.ordering', 'a.hits')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  128.  
  129.         //echo nl2br(str_replace('#__','jos_',$query));
  130.         return $query;
  131.     }
  132.  
  133.     /**
  134.      * Override the parnet getItems to inject optional data.
  135.      *
  136.      * @return  mixed  An array of objects on success, false on failure.
  137.      * @since   1.6
  138.      */
  139.     public function getItems()
  140.     {
  141.         $items = parent::getItems();
  142.  
  143.         // Determine if number of results for search item should be calculated
  144.         // by default it is `off` as it is highly query intensive
  145.         if ($this->getState('filter.results'))
  146.         {
  147.             JPluginHelper::importPlugin('search');
  148.             $app = JFactory::getApplication();
  149.  
  150.             if (!class_exists('JSite'))
  151.             {
  152.                 // This fools the routers in the search plugins into thinking it's in the frontend
  153.                 JLoader::register('JSite', JPATH_COMPONENT . '/helpers/site.php');
  154.             }
  155.  
  156.             foreach ($items as &$item)
  157.             {
  158.                 $results = $app->triggerEvent('onContentSearch', array($item->search_term));
  159.                 $item->returns = 0;
  160.                 foreach ($results as $result)
  161.                 {
  162.                     $item->returns += count($result);
  163.                 }
  164.             }
  165.         }
  166.  
  167.         return $items;
  168.     }
  169.  
  170.     /**
  171.      * Method to reset the seach log table.
  172.      *
  173.      * @return  boolean 
  174.      * @since   1.6
  175.      */
  176.     public function reset()
  177.     {
  178.         $db = $this->getDbo();
  179.         $db->setQuery(
  180.             'DELETE FROM #__core_log_searches'
  181.         );
  182.  
  183.         try
  184.         {
  185.             $db->execute();
  186.         }
  187.         catch (RuntimeException $e)
  188.         {
  189.             $this->setError($e->getMessage());
  190.             return false;
  191.         }
  192.  
  193.         return true;
  194.     }
  195. }

Documentation generated on Tue, 19 Nov 2013 15:12:45 +0100 by phpDocumentor 1.4.3