Source for file search.php

Documentation is available at search.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  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.  * Search Component Search Model
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_search
  17.  * @since       1.5
  18.  */
  19. class SearchModelSearch extends JModelLegacy
  20. {
  21.     /**
  22.      * Search data array
  23.      *
  24.      * @var array 
  25.      */
  26.     protected $_data = null;
  27.  
  28.     /**
  29.      * Search total
  30.      *
  31.      * @var integer 
  32.      */
  33.     protected $_total = null;
  34.  
  35.     /**
  36.      * Search areas
  37.      *
  38.      * @var integer 
  39.      */
  40.     protected  $_areas = null;
  41.  
  42.     /**
  43.      * Pagination object
  44.      *
  45.      * @var object 
  46.      */
  47.     protected $_pagination = null;
  48.  
  49.     /**
  50.      * Constructor
  51.      *
  52.      * @since 1.5
  53.      */
  54.     public function __construct()
  55.     {
  56.         parent::__construct();
  57.  
  58.         //Get configuration
  59.         $app    = JFactory::getApplication();
  60.         $config = JFactory::getConfig();
  61.  
  62.         // Get the pagination request variables
  63.         $this->setState('limit', $app->getUserStateFromRequest('com_search.limit', 'limit', $config->get('list_limit'), 'uint'));
  64.         $this->setState('limitstart', $app->input->get('limitstart', 0, 'uint'));
  65.  
  66.         // Set the search parameters
  67.         $keyword  = urldecode($app->input->getString('searchword'));
  68.         $match    = $app->input->get('searchphrase', 'all', 'word');
  69.         $ordering = $app->input->get('ordering', 'newest', 'word');
  70.         $this->setSearch($keyword, $match, $ordering);
  71.  
  72.         //Set the search areas
  73.         $areas = $app->input->get('areas', null, 'array');
  74.         $this->setAreas($areas);
  75.     }
  76.  
  77.     /**
  78.      * Method to set the search parameters
  79.      *
  80.      * @access    public
  81.      * @param string search string
  82.      * @param string mathcing option, exact|any|all
  83.      * @param string ordering option, newest|oldest|popular|alpha|category
  84.      */
  85.     public function setSearch($keyword, $match = 'all', $ordering = 'newest')
  86.     {
  87.         if (isset($keyword))
  88.         {
  89.             $this->setState('origkeyword', $keyword);
  90.             if ($match !== 'exact')
  91.             {
  92.                 $keyword = preg_replace('#\xE3\x80\x80#s', ' ', $keyword);
  93.             }
  94.             $this->setState('keyword', $keyword);
  95.         }
  96.  
  97.         if (isset($match))
  98.         {
  99.             $this->setState('match', $match);
  100.         }
  101.  
  102.         if (isset($ordering))
  103.         {
  104.             $this->setState('ordering', $ordering);
  105.         }
  106.     }
  107.  
  108.     /**
  109.      * Method to set the search areas
  110.      *
  111.      * @access    public
  112.      * @param   array  Active areas
  113.      * @param   array  Search areas
  114.      */
  115.     public function setAreas($active = array(), $search = array())
  116.     {
  117.         $this->_areas['active'] = $active;
  118.         $this->_areas['search'] = $search;
  119.     }
  120.  
  121.     /**
  122.      * Method to get weblink item data for the category
  123.      *
  124.      * @access public
  125.      * @return array 
  126.      */
  127.     public function getData()
  128.     {
  129.         // Lets load the content if it doesn't already exist
  130.         if (empty($this->_data))
  131.         {
  132.             $areas = $this->getAreas();
  133.  
  134.             JPluginHelper::importPlugin('search');
  135.             $dispatcher = JEventDispatcher::getInstance();
  136.             $results = $dispatcher->trigger('onContentSearch', array(
  137.                 $this->getState('keyword'),
  138.                 $this->getState('match'),
  139.                 $this->getState('ordering'),
  140.                 $areas['active'])
  141.             );
  142.  
  143.             $rows = array();
  144.             foreach ($results as $result)
  145.             {
  146.                 $rows = array_merge((array) $rows, (array) $result);
  147.             }
  148.  
  149.             $this->_total    = count($rows);
  150.             if ($this->getState('limit') > 0)
  151.             {
  152.                 $this->_data    = array_splice($rows, $this->getState('limitstart'), $this->getState('limit'));
  153.             } else {
  154.                 $this->_data = $rows;
  155.             }
  156.         }
  157.  
  158.         return $this->_data;
  159.     }
  160.  
  161.     /**
  162.      * Method to get the total number of weblink items for the category
  163.      *
  164.      * @access public
  165.      * @return  integer 
  166.      */
  167.     public function getTotal()
  168.     {
  169.         return $this->_total;
  170.     }
  171.  
  172.     /**
  173.      * Method to get a pagination object of the weblink items for the category
  174.      *
  175.      * @access public
  176.      * @return  integer 
  177.      */
  178.     public function getPagination()
  179.     {
  180.         // Lets load the content if it doesn't already exist
  181.         if (empty($this->_pagination))
  182.         {
  183.             $this->_pagination = new JPagination($this->getTotal(), $this->getState('limitstart'), $this->getState('limit'));
  184.         }
  185.  
  186.         return $this->_pagination;
  187.     }
  188.  
  189.     /**
  190.      * Method to get the search areas
  191.      *
  192.      * @since 1.5
  193.      */
  194.     public function getAreas()
  195.     {
  196.         // Load the Category data
  197.         if (empty($this->_areas['search']))
  198.         {
  199.             $areas = array();
  200.  
  201.             JPluginHelper::importPlugin('search');
  202.             $dispatcher = JEventDispatcher::getInstance();
  203.             $searchareas = $dispatcher->trigger('onContentSearchAreas');
  204.  
  205.             foreach ($searchareas as $area)
  206.             {
  207.                 if (is_array($area))
  208.                 {
  209.                     $areas = array_merge($areas, $area);
  210.                 }
  211.             }
  212.  
  213.             $this->_areas['search'] = $areas;
  214.         }
  215.  
  216.         return $this->_areas;
  217.     }
  218. }

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