Source for file styles.php

Documentation is available at styles.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_templates
  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 template style records.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_templates
  17.  * @since       1.6
  18.  */
  19. class TemplatesModelStyles extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  $config  An optional associative array of configuration settings.
  25.      *
  26.      * @see     JControllerLegacy
  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.                 'title', 'a.title',
  36.                 'client_id', 'a.client_id',
  37.                 'template', 'a.template',
  38.                 'home', 'a.home',
  39.             );
  40.         }
  41.  
  42.         parent::__construct($config);
  43.     }
  44.  
  45.     /**
  46.      * Method to auto-populate the model state.
  47.      *
  48.      * Note. Calling getState in this method will result in recursion.
  49.      *
  50.      * @param   string  $ordering   An optional ordering field.
  51.      * @param   string  $direction  An optional direction (asc|desc).
  52.      *
  53.      * @return  void 
  54.      *
  55.      * @since   1.6
  56.      */
  57.     protected function populateState($ordering = null, $direction = null)
  58.     {
  59.         // Load the filter state.
  60.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  61.         $this->setState('filter.search', $search);
  62.  
  63.         $template = $this->getUserStateFromRequest($this->context . '.filter.template', 'filter_template');
  64.         $this->setState('filter.template', $template);
  65.  
  66.         $clientId = $this->getUserStateFromRequest($this->context . '.filter.client_id', 'filter_client_id', null);
  67.         $this->setState('filter.client_id', $clientId);
  68.  
  69.         // Load the parameters.
  70.         $params = JComponentHelper::getParams('com_templates');
  71.         $this->setState('params', $params);
  72.  
  73.         // List state information.
  74.         parent::populateState('a.template', '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.template');
  93.         $id .= ':' . $this->getState('filter.client_id');
  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.         // Select the required fields from the table.
  110.         $query->select(
  111.             $this->getState(
  112.                 'list.select',
  113.                 'a.id, a.template, a.title, a.home, a.client_id, l.title AS language_title, l.image as image'
  114.             )
  115.         );
  116.         $query->from($db->quoteName('#__template_styles') . ' AS a');
  117.  
  118.         // Join on menus.
  119.         $query->select('COUNT(m.template_style_id) AS assigned')
  120.             ->join('LEFT', '#__menu AS m ON m.template_style_id = a.id')
  121.             ->group('a.id, a.template, a.title, a.home, a.client_id, l.title, l.image, e.extension_id');
  122.  
  123.         // Join over the language
  124.         $query->join('LEFT', '#__languages AS l ON l.lang_code = a.home');
  125.  
  126.         // Filter by extension enabled
  127.         $query->select('extension_id AS e_id')
  128.             ->join('LEFT', '#__extensions AS e ON e.element = a.template')
  129.             ->where('e.enabled = 1')
  130.             ->where('e.type=' . $db->quote('template'));
  131.  
  132.         // Filter by template.
  133.         if ($template = $this->getState('filter.template'))
  134.         {
  135.             $query->where('a.template = ' . $db->quote($template));
  136.         }
  137.  
  138.         // Filter by client.
  139.         $clientId = $this->getState('filter.client_id');
  140.  
  141.         if (is_numeric($clientId))
  142.         {
  143.             $query->where('a.client_id = ' . (int) $clientId);
  144.         }
  145.  
  146.         // Filter by search in title
  147.         $search = $this->getState('filter.search');
  148.  
  149.         if (!empty($search))
  150.         {
  151.             if (stripos($search, 'id:') === 0)
  152.             {
  153.                 $query->where('a.id = ' . (int) substr($search, 3));
  154.             }
  155.             else
  156.             {
  157.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  158.                 $query->where('a.template LIKE ' . $search . ' OR a.title LIKE ' . $search);
  159.             }
  160.         }
  161.  
  162.         // Add the list ordering clause.
  163.         $query->order($db->escape($this->getState('list.ordering', 'a.title')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  164.  
  165.         return $query;
  166.     }
  167. }

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