Source for file banners.php

Documentation is available at banners.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 BannersModelBanners 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.                 'id', 'a.id',
  34.                 'cid', 'a.cid', 'client_name',
  35.                 'name', 'a.name',
  36.                 'alias', 'a.alias',
  37.                 'state', 'a.state',
  38.                 'ordering', 'a.ordering',
  39.                 'language', 'a.language',
  40.                 'catid', 'a.catid', 'category_title',
  41.                 'checked_out', 'a.checked_out',
  42.                 'checked_out_time', 'a.checked_out_time',
  43.                 'created', 'a.created',
  44.                 'impmade', 'a.impmade',
  45.                 'imptotal', 'a.imptotal',
  46.                 'clicks', 'a.clicks',
  47.                 'publish_up', 'a.publish_up',
  48.                 'publish_down', 'a.publish_down',
  49.                 'state', 'sticky', 'a.sticky',
  50.                 'client_id',
  51.                 'category_id',
  52.                 'published'
  53.             );
  54.         }
  55.  
  56.         parent::__construct($config);
  57.     }
  58.  
  59.     /**
  60.      * Method to get the maximum ordering value for each category.
  61.      *
  62.      * @since   1.6
  63.      */
  64.     public function &getCategoryOrders()
  65.     {
  66.         if (!isset($this->cache['categoryorders']))
  67.         {
  68.             $db = $this->getDbo();
  69.             $query = $db->getQuery(true)
  70.                 ->select('MAX(ordering) as ' . $db->quoteName('max') . ', catid')
  71.                 ->select('catid')
  72.                 ->from('#__banners')
  73.                 ->group('catid');
  74.             $db->setQuery($query);
  75.             $this->cache['categoryorders'] = $db->loadAssocList('catid', 0);
  76.         }
  77.         return $this->cache['categoryorders'];
  78.     }
  79.  
  80.     /**
  81.      * Build an SQL query to load the list data.
  82.      *
  83.      * @return  JDatabaseQuery 
  84.      * @since   1.6
  85.      */
  86.     protected function getListQuery()
  87.     {
  88.         $db = $this->getDbo();
  89.         $query = $db->getQuery(true);
  90.  
  91.         // Select the required fields from the table.
  92.         $query->select(
  93.             $this->getState(
  94.                 'list.select',
  95.                 'a.id AS id, a.name AS name, a.alias AS alias,' .
  96.                     'a.checked_out AS checked_out,' .
  97.                     'a.checked_out_time AS checked_out_time, a.catid AS catid,' .
  98.                     'a.clicks AS clicks, a.metakey AS metakey, a.sticky AS sticky,' .
  99.                     'a.impmade AS impmade, a.imptotal AS imptotal,' .
  100.                     'a.state AS state, a.ordering AS ordering,' .
  101.                     'a.purchase_type as purchase_type,' .
  102.                     'a.language, a.publish_up, a.publish_down'
  103.             )
  104.         );
  105.         $query->from($db->quoteName('#__banners') . ' AS a');
  106.  
  107.         // Join over the language
  108.         $query->select('l.title AS language_title')
  109.             ->join('LEFT', $db->quoteName('#__languages') . ' AS l ON l.lang_code = a.language');
  110.  
  111.         // Join over the users for the checked out user.
  112.         $query->select('uc.name AS editor')
  113.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  114.  
  115.         // Join over the categories.
  116.         $query->select('c.title AS category_title')
  117.             ->join('LEFT', '#__categories AS c ON c.id = a.catid');
  118.  
  119.         // Join over the clients.
  120.         $query->select('cl.name AS client_name,cl.purchase_type as client_purchase_type')
  121.             ->join('LEFT', '#__banner_clients AS cl ON cl.id = a.cid');
  122.  
  123.         // Filter by published state
  124.         $published = $this->getState('filter.state');
  125.         if (is_numeric($published))
  126.         {
  127.             $query->where('a.state = ' . (int) $published);
  128.         }
  129.         elseif ($published === '')
  130.         {
  131.             $query->where('(a.state IN (0, 1))');
  132.         }
  133.  
  134.         // Filter by category.
  135.         $categoryId = $this->getState('filter.category_id');
  136.         if (is_numeric($categoryId))
  137.         {
  138.             $query->where('a.catid = ' . (int) $categoryId);
  139.         }
  140.  
  141.         // Filter by client.
  142.         $clientId = $this->getState('filter.client_id');
  143.         if (is_numeric($clientId))
  144.         {
  145.             $query->where('a.cid = ' . (int) $clientId);
  146.         }
  147.  
  148.         // Filter by search in title
  149.         $search = $this->getState('filter.search');
  150.         if (!empty($search))
  151.         {
  152.             if (stripos($search, 'id:') === 0)
  153.             {
  154.                 $query->where('a.id = ' . (int) substr($search, 3));
  155.             }
  156.             else
  157.             {
  158.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  159.                 $query->where('(a.name LIKE ' . $search . ' OR a.alias LIKE ' . $search . ')');
  160.             }
  161.         }
  162.  
  163.         // Filter on the language.
  164.         if ($language = $this->getState('filter.language'))
  165.         {
  166.             $query->where('a.language = ' . $db->quote($language));
  167.         }
  168.  
  169.         // Add the list ordering clause.
  170.         $orderCol = $this->state->get('list.ordering', 'ordering');
  171.         $orderDirn = $this->state->get('list.direction', 'ASC');
  172.         if ($orderCol == 'ordering' || $orderCol == 'category_title')
  173.         {
  174.             $orderCol = 'c.title ' . $orderDirn . ', a.ordering';
  175.         }
  176.         if ($orderCol == 'client_name')
  177.         {
  178.             $orderCol = 'cl.name';
  179.         }
  180.         $query->order($db->escape($orderCol . ' ' . $orderDirn));
  181.  
  182.         return $query;
  183.     }
  184.  
  185.     /**
  186.      * Method to get a store id based on model configuration state.
  187.      *
  188.      * This is necessary because the model is used by the component and
  189.      * different modules that might need different sets of data or different
  190.      * ordering requirements.
  191.      *
  192.      * @param   string  $id    A prefix for the store id.
  193.      * @return  string  A store id.
  194.      * @since   1.6
  195.      */
  196.     protected function getStoreId($id = '')
  197.     {
  198.         // Compile the store id.
  199.         $id .= ':' . $this->getState('filter.search');
  200.         $id .= ':' . $this->getState('filter.access');
  201.         $id .= ':' . $this->getState('filter.state');
  202.         $id .= ':' . $this->getState('filter.category_id');
  203.         $id .= ':' . $this->getState('filter.language');
  204.  
  205.         return parent::getStoreId($id);
  206.     }
  207.  
  208.     /**
  209.      * Returns a reference to the a Table object, always creating it.
  210.      *
  211.      * @param   type      The table type to instantiate
  212.      * @param   string    A prefix for the table class name. Optional.
  213.      * @param   array     Configuration array for model. Optional.
  214.      * @return  JTable    A database object
  215.      * @since   1.6
  216.      */
  217.     public function getTable($type = 'Banner', $prefix = 'BannersTable', $config = array())
  218.     {
  219.         return JTable::getInstance($type, $prefix, $config);
  220.     }
  221.  
  222.     /**
  223.      * Method to auto-populate the model state.
  224.      *
  225.      * Note. Calling getState in this method will result in recursion.
  226.      *
  227.      * @since   1.6
  228.      */
  229.     protected function populateState($ordering = null, $direction = null)
  230.     {
  231.         // Load the filter state.
  232.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  233.         $this->setState('filter.search', $search);
  234.  
  235.         $state = $this->getUserStateFromRequest($this->context . '.filter.state', 'filter_state', '', 'string');
  236.         $this->setState('filter.state', $state);
  237.  
  238.         $categoryId = $this->getUserStateFromRequest($this->context . '.filter.category_id', 'filter_category_id', '');
  239.         $this->setState('filter.category_id', $categoryId);
  240.  
  241.         $clientId = $this->getUserStateFromRequest($this->context . '.filter.client_id', 'filter_client_id', '');
  242.         $this->setState('filter.client_id', $clientId);
  243.  
  244.         $language = $this->getUserStateFromRequest($this->context . '.filter.language', 'filter_language', '');
  245.         $this->setState('filter.language', $language);
  246.  
  247.         // Load the parameters.
  248.         $params = JComponentHelper::getParams('com_banners');
  249.         $this->setState('params', $params);
  250.  
  251.         // List state information.
  252.         parent::populateState('a.name', 'asc');
  253.     }
  254. }

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