Source for file templates.php

Documentation is available at templates.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 extension records.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_templates
  17.  * @since       1.6
  18.  */
  19. class TemplatesModelTemplates 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.                 'name', 'a.name',
  36.                 'folder', 'a.folder',
  37.                 'element', 'a.element',
  38.                 'checked_out', 'a.checked_out',
  39.                 'checked_out_time', 'a.checked_out_time',
  40.                 'state', 'a.state',
  41.                 'enabled', 'a.enabled',
  42.                 'access', 'a.access', 'access_level',
  43.                 'ordering', 'a.ordering',
  44.                 'client_id', 'a.client_id',
  45.             );
  46.         }
  47.  
  48.         parent::__construct($config);
  49.     }
  50.  
  51.     /**
  52.      * Override parent getItems to add extra XML metadata.
  53.      *
  54.      * @return  array 
  55.      *
  56.      * @since   1.6
  57.      */
  58.     public function getItems()
  59.     {
  60.         $items = parent::getItems();
  61.  
  62.         foreach ($items as &$item)
  63.         {
  64.             $client = JApplicationHelper::getClientInfo($item->client_id);
  65.             $item->xmldata = TemplatesHelper::parseXMLTemplateFile($client->path, $item->element);
  66.         }
  67.  
  68.         return $items;
  69.     }
  70.  
  71.     /**
  72.      * Build an SQL query to load the list data.
  73.      *
  74.      * @return  JDatabaseQuery 
  75.      *
  76.      * @since   1.6
  77.      */
  78.     protected function getListQuery()
  79.     {
  80.         // Create a new query object.
  81.         $db = $this->getDbo();
  82.         $query = $db->getQuery(true);
  83.  
  84.         // Select the required fields from the table.
  85.         $query->select(
  86.             $this->getState(
  87.                 'list.select',
  88.                 'a.extension_id, a.name, a.element, a.client_id'
  89.             )
  90.         );
  91.         $query->from($db->quoteName('#__extensions') . ' AS a');
  92.  
  93.         // Filter by extension type.
  94.         $query->where($db->quoteName('type') . ' = ' . $db->quote('template'));
  95.  
  96.         // Filter by client.
  97.         $clientId = $this->getState('filter.client_id');
  98.  
  99.         if (is_numeric($clientId))
  100.         {
  101.             $query->where('a.client_id = ' . (int) $clientId);
  102.         }
  103.  
  104.         // Filter by search in title
  105.         $search = $this->getState('filter.search');
  106.  
  107.         if (!empty($search))
  108.         {
  109.             if (stripos($search, 'id:') === 0)
  110.             {
  111.                 $query->where('a.id = ' . (int) substr($search, 3));
  112.             }
  113.             else
  114.             {
  115.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  116.                 $query->where('(a.element LIKE ' . $search . ' OR a.name LIKE ' . $search . ')');
  117.             }
  118.         }
  119.  
  120.         // Add the list ordering clause.
  121.         $query->order($db->escape($this->getState('list.ordering', 'a.folder')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  122.  
  123.         return $query;
  124.     }
  125.  
  126.     /**
  127.      * Method to get a store id based on model configuration state.
  128.      *
  129.      * This is necessary because the model is used by the component and
  130.      * different modules that might need different sets of data or different
  131.      * ordering requirements.
  132.      *
  133.      * @param   string  $id  A prefix for the store id.
  134.      *
  135.      * @return  string  A store id.
  136.      *
  137.      * @since   1.6
  138.      */
  139.     protected function getStoreId($id = '')
  140.     {
  141.         // Compile the store id.
  142.         $id .= ':' . $this->getState('filter.search');
  143.         $id .= ':' . $this->getState('filter.client_id');
  144.  
  145.         return parent::getStoreId($id);
  146.     }
  147.  
  148.     /**
  149.      * Method to auto-populate the model state.
  150.      *
  151.      * Note. Calling getState in this method will result in recursion.
  152.      *
  153.      * @param   string  $ordering   An optional ordering field.
  154.      * @param   string  $direction  An optional direction (asc|desc).
  155.      *
  156.      * @return  void 
  157.      *
  158.      * @since   1.6
  159.      */
  160.     protected function populateState($ordering = null, $direction = null)
  161.     {
  162.         // Load the filter state.
  163.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  164.         $this->setState('filter.search', $search);
  165.  
  166.         $clientId = $this->getUserStateFromRequest($this->context . '.filter.client_id', 'filter_client_id', null);
  167.         $this->setState('filter.client_id', $clientId);
  168.  
  169.         // Load the parameters.
  170.         $params = JComponentHelper::getParams('com_templates');
  171.         $this->setState('params', $params);
  172.  
  173.         // List state information.
  174.         parent::populateState('a.element', 'asc');
  175.     }
  176. }

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