Source for file clients.php

Documentation is available at clients.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_banners
  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 banner records.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_banners
  17.  * @since       1.6
  18.  */
  19. class BannersModelClients extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  $config  An optional associative array of configuration settings.
  25.      *
  26.      * @see     JController
  27.      * @since   1.6
  28.      */
  29.     public function __construct($config = array())
  30.     {
  31.         if (empty($config['filter_fields']))
  32.         {
  33.             $config['filter_fields'] = array(
  34.                 'id', 'a.id',
  35.                 'name', 'a.name',
  36.                 'contact', 'a.contact',
  37.                 'state', 'a.state',
  38.                 'checked_out', 'a.checked_out',
  39.                 'checked_out_time', 'a.checked_out_time',
  40.                 'nbanners',
  41.                 'purchase_type'
  42.             );
  43.         }
  44.  
  45.         parent::__construct($config);
  46.     }
  47.  
  48.     /**
  49.      * Method to auto-populate the model state.
  50.      *
  51.      * Note. Calling getState in this method will result in recursion.
  52.      *
  53.      * @param   string  $ordering   An optional ordering field.
  54.      * @param   string  $direction  An optional direction (asc|desc).
  55.      *
  56.      * @return  void 
  57.      *
  58.      * @since   1.6
  59.      */
  60.     protected function populateState($ordering = null, $direction = null)
  61.     {
  62.         // Load the filter state.
  63.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  64.         $this->setState('filter.search', $search);
  65.  
  66.         $state = $this->getUserStateFromRequest($this->context . '.filter.state', 'filter_state', '', 'string');
  67.         $this->setState('filter.state', $state);
  68.  
  69.         // Load the parameters.
  70.         $params = JComponentHelper::getParams('com_banners');
  71.         $this->setState('params', $params);
  72.  
  73.         // List state information.
  74.         parent::populateState('a.name', 'asc');
  75.     }
  76.  
  77.     /**
  78.      * Method to get a store id based on model configuration state.
  79.      *
  80.      * This is necessary because the model is used by the component and
  81.      * different modules that might need different sets of data or different
  82.      * ordering requirements.
  83.      *
  84.      * @param   string  $id  A prefix for the store id.
  85.      *
  86.      * @return  string  A store id.
  87.      */
  88.     protected function getStoreId($id = '')
  89.     {
  90.         // Compile the store id.
  91.         $id .= ':' . $this->getState('filter.search');
  92.         $id .= ':' . $this->getState('filter.access');
  93.         $id .= ':' . $this->getState('filter.state');
  94.  
  95.         return parent::getStoreId($id);
  96.     }
  97.  
  98.     /**
  99.      * Build an SQL query to load the list data.
  100.      *
  101.      * @return  JDatabaseQuery 
  102.      */
  103.     protected function getListQuery()
  104.     {
  105.         // Create a new query object.
  106.         $db = $this->getDbo();
  107.         $query = $db->getQuery(true);
  108.  
  109.         $params = JComponentHelper::getParams('com_banners');
  110.         $defaultPurchase = $params->get('purchase_type', 3);
  111.  
  112.         // Select the required fields from the table.
  113.         $query->select(
  114.             $this->getState(
  115.                 'list.select',
  116.                 'a.id AS id,' .
  117.                     'a.name AS name,' .
  118.                     'a.contact AS contact,' .
  119.                     'a.checked_out AS checked_out,' .
  120.                     'a.checked_out_time AS checked_out_time, ' .
  121.                     'a.state AS state,' .
  122.                     'a.metakey AS metakey,' .
  123.                     'a.purchase_type as purchase_type'
  124.             )
  125.         );
  126.  
  127.         $query->from($db->quoteName('#__banner_clients') . ' AS a');
  128.  
  129.         // Join over the banners for counting
  130.         $query->select('COUNT(b.id) as nbanners')
  131.             ->join('LEFT', '#__banners AS b ON a.id = b.cid');
  132.  
  133.         // Join over the users for the checked out user.
  134.         $query->select('uc.name AS editor')
  135.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  136.  
  137.         // Filter by published state
  138.         $published = $this->getState('filter.state');
  139.  
  140.         if (is_numeric($published))
  141.         {
  142.             $query->where('a.state = ' . (int) $published);
  143.         }
  144.         elseif ($published === '')
  145.         {
  146.             $query->where('(a.state IN (0, 1))');
  147.         }
  148.  
  149.         $query->group('a.id, a.name, a.contact, a.checked_out, a.checked_out_time, a.state, a.metakey, a.purchase_type, uc.name');
  150.  
  151.         // Filter by search in title
  152.         $search = $this->getState('filter.search');
  153.  
  154.         if (!empty($search))
  155.         {
  156.             if (stripos($search, 'id:') === 0)
  157.             {
  158.                 $query->where('a.id = ' . (int) substr($search, 3));
  159.             }
  160.             else
  161.             {
  162.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  163.                 $query->where('a.name LIKE ' . $search);
  164.             }
  165.         }
  166.  
  167.         // Filter by purchase type
  168.         $purchaseType = $this->getState('filter.purchase_type');
  169.  
  170.         if (!empty($purchaseType))
  171.         {
  172.             if ($defaultPurchase == $purchaseType)
  173.             {
  174.                 $query->where('(a.purchase_type = ' . (int) $purchaseType . ' OR a.purchase_type = -1)');
  175.             }
  176.             else
  177.             {
  178.                 $query->where('a.purchase_type = ' . (int) $purchaseType);
  179.             }
  180.         }
  181.  
  182.         $ordering = $this->getState('list.ordering', 'ordering');
  183.  
  184.         if ($ordering == 'nbanners')
  185.         {
  186.             $ordering = 'COUNT(b.id)';
  187.         }
  188.  
  189.         // Add the list ordering clause.
  190.         $query->order($db->escape($ordering) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  191.  
  192.         return $query;
  193.     }
  194. }

Documentation generated on Tue, 19 Nov 2013 14:55:54 +0100 by phpDocumentor 1.4.3