Source for file filters.php

Documentation is available at filters.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  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. /**
  13.  * Filters model class for Finder.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_finder
  17.  * @since       2.5
  18.  */
  19. class FinderModelFilters extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  $config  An associative array of configuration settings. [optional]
  25.      *
  26.      * @since   2.5
  27.      * @see     JController
  28.      */
  29.     public function __construct($config = array())
  30.     {
  31.         if (empty($config['filter_fields']))
  32.         {
  33.             $config['filter_fields'] = array(
  34.                 'filter_id', 'a.filter_id',
  35.                 'title', 'a.title',
  36.                 'state', 'a.state',
  37.                 'created_by_alias', 'a.created_by_alias',
  38.                 'created', 'a.created',
  39.                 'map_count', 'a.map_count'
  40.             );
  41.         }
  42.  
  43.         parent::__construct($config);
  44.     }
  45.  
  46.     /**
  47.      * Build an SQL query to load the list data.
  48.      *
  49.      * @return  JDatabaseQuery  A JDatabaseQuery object
  50.      *
  51.      * @since   2.5
  52.      */
  53.     protected function getListQuery()
  54.     {
  55.         $db = $this->getDbo();
  56.         $query = $db->getQuery(true);
  57.  
  58.         // Select all fields from the table.
  59.         $query->select('a.*')
  60.             ->from($db->quoteName('#__finder_filters') . ' AS a');
  61.  
  62.         // Join over the users for the checked out user.
  63.         $query->select('uc.name AS editor')
  64.             ->join('LEFT', $db->quoteName('#__users') . ' AS uc ON uc.id=a.checked_out');
  65.  
  66.         // Join over the users for the author.
  67.         $query->select('ua.name AS user_name')
  68.             ->join('LEFT', $db->quoteName('#__users') . ' AS ua ON ua.id = a.created_by');
  69.  
  70.         // Check for a search filter.
  71.         if ($this->getState('filter.search'))
  72.         {
  73.             $query->where('( a.title LIKE \'%' . $db->escape($this->getState('filter.search')) . '%\' )');
  74.         }
  75.  
  76.         // If the model is set to check item state, add to the query.
  77.         if (is_numeric($this->getState('filter.state')))
  78.         {
  79.             $query->where('a.state = ' . (int) $this->getState('filter.state'));
  80.         }
  81.  
  82.         // Add the list ordering clause.
  83.         $query->order($db->escape($this->getState('list.ordering') . ' ' . $db->escape($this->getState('list.direction'))));
  84.  
  85.         return $query;
  86.     }
  87.  
  88.     /**
  89.      * Method to get a store id based on model configuration state.
  90.      *
  91.      * This is necessary because the model is used by the component and
  92.      * different modules that might need different sets of data or different
  93.      * ordering requirements.
  94.      *
  95.      * @param   string  $id  A prefix for the store id. [optional]
  96.      *
  97.      * @return  string  A store id.
  98.      *
  99.      * @since   2.5
  100.      */
  101.     protected function getStoreId($id = '')
  102.     {
  103.         // Compile the store id.
  104.         $id .= ':' . $this->getState('filter.search');
  105.         $id .= ':' . $this->getState('filter.state');
  106.  
  107.         return parent::getStoreId($id);
  108.     }
  109.  
  110.     /**
  111.      * Method to auto-populate the model state.  Calling getState in this method will result in recursion.
  112.      *
  113.      * @param   string  $ordering   An optional ordering field. [optional]
  114.      * @param   string  $direction  An optional direction. [optional]
  115.      *
  116.      * @return  void 
  117.      *
  118.      * @since   2.5
  119.      */
  120.     protected function populateState($ordering = null, $direction = null)
  121.     {
  122.         // Load the filter state.
  123.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  124.         $this->setState('filter.search', $search);
  125.  
  126.         $state = $this->getUserStateFromRequest($this->context . '.filter.state', 'filter_state', '', 'string');
  127.         $this->setState('filter.state', $state);
  128.  
  129.         // Load the parameters.
  130.         $params = JComponentHelper::getParams('com_finder');
  131.         $this->setState('params', $params);
  132.  
  133.         // List state information.
  134.         parent::populateState('a.title', 'asc');
  135.     }
  136. }

Documentation generated on Tue, 19 Nov 2013 15:03:21 +0100 by phpDocumentor 1.4.3