Source for file suggestions.php

Documentation is available at suggestions.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_finder
  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
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. define('FINDER_PATH_INDEXER', JPATH_ADMINISTRATOR . '/components/com_finder/helpers/indexer');
  13. JLoader::register('FinderIndexerHelper', FINDER_PATH_INDEXER . '/helper.php');
  14.  
  15. /**
  16.  * Suggestions model class for the Finder package.
  17.  *
  18.  * @package     Joomla.Site
  19.  * @subpackage  com_finder
  20.  * @since       2.5
  21.  */
  22. class FinderModelSuggestions extends JModelList
  23. {
  24.     /**
  25.      * Context string for the model type.
  26.      *
  27.      * @var    string 
  28.      * @since  2.5
  29.      */
  30.     protected $context = 'com_finder.suggestions';
  31.  
  32.     /**
  33.      * Method to get an array of data items.
  34.      *
  35.      * @return  array  An array of data items.
  36.      *
  37.      * @since   2.5
  38.      */
  39.     public function getItems()
  40.     {
  41.         // Get the items.
  42.         $items = parent::getItems();
  43.  
  44.         // Convert them to a simple array.
  45.         foreach ($items as $k => $v)
  46.         {
  47.             $items[$k] = $v->term;
  48.         }
  49.  
  50.         return $items;
  51.     }
  52.  
  53.     /**
  54.      * Method to build a database query to load the list data.
  55.      *
  56.      * @return  JDatabaseQuery  A database query
  57.      *
  58.      * @since   2.5
  59.      */
  60.     protected function getListQuery()
  61.     {
  62.         // Create a new query object.
  63.         $db = $this->getDbo();
  64.         $query = $db->getQuery(true);
  65.  
  66.         // Select required fields
  67.         $query->select('t.term')
  68.             ->from($db->quoteName('#__finder_terms') . ' AS t')
  69.             ->where('t.term LIKE ' . $db->quote($db->escape($this->getState('input'), true) . '%'))
  70.             ->where('t.common = 0')
  71.             ->where('t.language IN (' . $db->quote($db->escape($this->getState('language'), true)) . ', ' . $db->quote('*') . ')')
  72.             ->order('t.links DESC')
  73.             ->order('t.weight DESC');
  74.  
  75.         return $query;
  76.     }
  77.  
  78.     /**
  79.      * Method to get a store id based on model the configuration state.
  80.      *
  81.      * This is necessary because the model is used by the component and
  82.      * different modules that might need different sets of data or different
  83.      * ordering requirements.
  84.      *
  85.      * @param   string  $id  An identifier string to generate the store id. [optional]
  86.      *
  87.      * @return  string  A store id.
  88.      *
  89.      * @since   2.5
  90.      */
  91.     protected function getStoreId($id = '')
  92.     {
  93.         // Add the search query state.
  94.         $id .= ':' . $this->getState('input');
  95.         $id .= ':' . $this->getState('language');
  96.  
  97.         // Add the list state.
  98.         $id .= ':' . $this->getState('list.start');
  99.         $id .= ':' . $this->getState('list.limit');
  100.  
  101.         return parent::getStoreId($id);
  102.     }
  103.  
  104.     /**
  105.      * Method to auto-populate the model state.  Calling getState in this method will result in recursion.
  106.      *
  107.      * @param   string  $ordering   An optional ordering field.
  108.      * @param   string  $direction  An optional direction (asc|desc).
  109.      *
  110.      * @return  void 
  111.      *
  112.      * @since   2.5
  113.      */
  114.     protected function populateState($ordering = null, $direction = null)
  115.     {
  116.         // Get the configuration options.
  117.         $app = JFactory::getApplication();
  118.         $input = $app->input;
  119.         $params = JComponentHelper::getParams('com_finder');
  120.         $user = JFactory::getUser();
  121.  
  122.         // Get the query input.
  123.         $this->setState('input', $input->request->get('q', '', 'string'));
  124.  
  125.         // Set the query language
  126.         $lang = FinderIndexerHelper::getDefaultLanguage();
  127.         $lang = FinderIndexerHelper::getPrimaryLanguage($lang);
  128.         $this->setState('language', $lang);
  129.  
  130.         // Load the list state.
  131.         $this->setState('list.start', 0);
  132.         $this->setState('list.limit', 10);
  133.  
  134.         // Load the parameters.
  135.         $this->setState('params', $params);
  136.  
  137.         // Load the user state.
  138.         $this->setState('user.id', (int) $user->get('id'));
  139.     }
  140. }

Documentation generated on Tue, 19 Nov 2013 15:14:44 +0100 by phpDocumentor 1.4.3