Source for file positions.php

Documentation is available at positions.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_modules
  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.  * Modules Component Positions Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_modules
  17.  * @since       1.6
  18.  */
  19. class ModulesModelPositions 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.                 'value',
  34.                 'templates',
  35.             );
  36.         }
  37.  
  38.         parent::__construct($config);
  39.     }
  40.  
  41.     /**
  42.      * Method to auto-populate the model state.
  43.      *
  44.      * Note. Calling getState in this method will result in recursion.
  45.      *
  46.      * @since   1.6
  47.      */
  48.     protected function populateState($ordering = null, $direction = null)
  49.     {
  50.         $app = JFactory::getApplication('administrator');
  51.  
  52.         // Load the filter state.
  53.         $search = $this->getUserStateFromRequest($this->context.'.filter.search', 'filter_search');
  54.         $this->setState('filter.search', $search);
  55.  
  56.         $state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');
  57.         $this->setState('filter.state', $state);
  58.  
  59.         $clientId = $app->input->getInt('client_id', 0);
  60.         $this->setState('filter.client_id', $clientId);
  61.  
  62.         $template = $this->getUserStateFromRequest($this->context.'.filter.template', 'filter_template', '', 'string');
  63.         $this->setState('filter.template', $template);
  64.  
  65.         $type = $this->getUserStateFromRequest($this->context.'.filter.type', 'filter_type', '', 'string');
  66.         $this->setState('filter.type', $type);
  67.  
  68.         // Load the parameters.
  69.         $params = JComponentHelper::getParams('com_modules');
  70.         $this->setState('params', $params);
  71.  
  72.         // List state information.
  73.         parent::populateState('value', 'asc');
  74.     }
  75.  
  76.     /**
  77.      * Method to get an array of data items.
  78.      *
  79.      * @return  mixed  An array of data items on success, false on failure.
  80.      * @since   1.6
  81.      */
  82.     public function getItems()
  83.     {
  84.         if (!isset($this->items))
  85.         {
  86.             $lang            = JFactory::getLanguage();
  87.             $search          = $this->getState('filter.search');
  88.             $state           = $this->getState('filter.state');
  89.             $clientId        = $this->getState('filter.client_id');
  90.             $filter_template = $this->getState('filter.template');
  91.             $type            = $this->getState('filter.type');
  92.             $ordering        = $this->getState('list.ordering');
  93.             $direction       = $this->getState('list.direction');
  94.             $limitstart      = $this->getState('list.start');
  95.             $limit           = $this->getState('list.limit');
  96.             $client          = JApplicationHelper::getClientInfo($clientId);
  97.  
  98.             if ($type != 'template')
  99.             {
  100.                 // Get the database object and a new query object.
  101.                 $query    = $this->_db->getQuery(true)
  102.                     ->select('DISTINCT(position) as value')
  103.                     ->from('#__modules')
  104.                     ->where($this->_db->quoteName('client_id').' = '.(int) $clientId);
  105.                 if ($search)
  106.                 {
  107.                     $query->where('position LIKE '.$this->_db->quote('%'.$this->_db->escape($search, true).'%'));
  108.                 }
  109.  
  110.                 $this->_db->setQuery($query);
  111.  
  112.                 try
  113.                 {
  114.                     $positions = $this->_db->loadObjectList('value');
  115.                 }
  116.                 catch (RuntimeException $e)
  117.                 {
  118.                     $this->setError($e->getMessage());
  119.                     return false;
  120.                 }
  121.                 foreach ($positions as $value => $position)
  122.                 {
  123.                     $positions[$value] = array();
  124.                 }
  125.             }
  126.             else
  127.             {
  128.                 $positions = array();
  129.             }
  130.  
  131.             // Load the positions from the installed templates.
  132.             foreach (ModulesHelper::getTemplates($clientId) as $template)
  133.             {
  134.                 $path = JPath::clean($client->path.'/templates/'.$template->element.'/templateDetails.xml');
  135.  
  136.                 if (file_exists($path))
  137.                 {
  138.                     $xml = simplexml_load_file($path);
  139.                     if (isset($xml->positions[0]))
  140.                     {
  141.                         $lang->load('tpl_'.$template->element.'.sys', $client->path, null, false, true)
  142.                     ||    $lang->load('tpl_'.$template->element.'.sys', $client->path.'/templates/'.$template->element, null, false, true);
  143.                         foreach ($xml->positions[0] as $position)
  144.                         {
  145.                             $value = (string) $position['value'];
  146.                             $label = (string) $position;
  147.                             if (!$value)
  148.                             {
  149.                                 $value = $label;
  150.                                 $label = preg_replace('/[^a-zA-Z0-9_\-]/', '_', 'TPL_'.$template->element.'_POSITION_'.$value);
  151.                                 $altlabel = preg_replace('/[^a-zA-Z0-9_\-]/', '_', 'COM_MODULES_POSITION_'.$value);
  152.                                 if (!$lang->hasKey($label) && $lang->hasKey($altlabel))
  153.                                 {
  154.                                     $label = $altlabel;
  155.                                 }
  156.                             }
  157.                             if ($type == 'user' || ($state != '' && $state != $template->enabled))
  158.                             {
  159.                                 unset($positions[$value]);
  160.                             }
  161.                             elseif (preg_match(chr(1) . $search . chr(1) . 'i', $value) && ($filter_template == '' || $filter_template == $template->element))
  162.                             {
  163.                                 if (!isset($positions[$value]))
  164.                                 {
  165.                                     $positions[$value] = array();
  166.                                 }
  167.                                 $positions[$value][$template->name] = $label;
  168.                             }
  169.                         }
  170.                     }
  171.                 }
  172.             }
  173.             $this->total = count($positions);
  174.             if ($limitstart >= $this->total)
  175.             {
  176.                 $limitstart = $limitstart < $limit ? 0 : $limitstart - $limit;
  177.                 $this->setState('list.start', $limitstart);
  178.             }
  179.             if ($ordering == 'value')
  180.             {
  181.                 if ($direction == 'asc')
  182.                 {
  183.                     ksort($positions);
  184.                 }
  185.                 else {
  186.                     krsort($positions);
  187.                 }
  188.             }
  189.             else {
  190.                 if ($direction == 'asc')
  191.                 {
  192.                     asort($positions);
  193.                 }
  194.                 else {
  195.                     arsort($positions);
  196.                 }
  197.             }
  198.             $this->items = array_slice($positions, $limitstart, $limit ? $limit : null);
  199.         }
  200.         return $this->items;
  201.     }
  202.  
  203.     /**
  204.      * Method to get the total number of items.
  205.      *
  206.      * @return  int    The total number of items.
  207.      * @since   1.6
  208.      */
  209.     public function getTotal()
  210.     {
  211.         if (!isset($this->total))
  212.         {
  213.             $this->getItems();
  214.         }
  215.         return $this->total;
  216.     }
  217. }

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