Source for file languages.php

Documentation is available at languages.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_languages
  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.  * Languages Model Class
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_languages
  17.  * @since       1.6
  18.  */
  19. class LanguagesModelLanguages 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.                 'lang_id', 'a.lang_id',
  34.                 'lang_code', 'a.lang_code',
  35.                 'title', 'a.title',
  36.                 'title_native', 'a.title_native',
  37.                 'sef', 'a.sef',
  38.                 'image', 'a.image',
  39.                 'published', 'a.published',
  40.                 'ordering', 'a.ordering',
  41.                 'access', 'a.access', 'access_level',
  42.                 'home', 'l.home',
  43.             );
  44.         }
  45.  
  46.         parent::__construct($config);
  47.     }
  48.  
  49.     /**
  50.      * Method to auto-populate the model state.
  51.      *
  52.      * Note. Calling getState in this method will result in recursion.
  53.      *
  54.      * @param   string  $ordering   An optional ordering field.
  55.      * @param   string  $direction  An optional direction (asc|desc).
  56.      *
  57.      * @return  void 
  58.      *
  59.      * @since   1.6
  60.      */
  61.     protected function populateState($ordering = null, $direction = null)
  62.     {
  63.         // Load the filter state.
  64.         $search = $this->getUserStateFromRequest($this->context . '.search', 'filter_search');
  65.         $this->setState('filter.search', $search);
  66.  
  67.         $accessId = $this->getUserStateFromRequest($this->context . '.access', 'filter_access', null, 'int');
  68.         $this->setState('filter.access', $accessId);
  69.  
  70.         $published = $this->getUserStateFromRequest($this->context . '.published', 'filter_published', '');
  71.         $this->setState('filter.published', $published);
  72.  
  73.         // Load the parameters.
  74.         $params = JComponentHelper::getParams('com_languages');
  75.         $this->setState('params', $params);
  76.  
  77.         // List state information.
  78.         parent::populateState('a.title', 'asc');
  79.     }
  80.  
  81.     /**
  82.      * Method to get a store id based on model configuration state.
  83.      *
  84.      * This is necessary because the model is used by the component and
  85.      * different modules that might need different sets of data or different
  86.      * ordering requirements.
  87.      *
  88.      * @param   string  $id    A prefix for the store id.
  89.      *
  90.      * @return  string  A store id.
  91.      * @since   1.6
  92.      */
  93.     protected function getStoreId($id = '')
  94.     {
  95.         // Compile the store id.
  96.         $id .= ':' . $this->getState('filter.search');
  97.         $id .= ':' . $this->getState('filter.access');
  98.         $id .= ':' . $this->getState('filter.published');
  99.  
  100.         return parent::getStoreId($id);
  101.     }
  102.  
  103.     /**
  104.      * Method to build an SQL query to load the list data.
  105.      *
  106.      * @return  string    An SQL query
  107.      * @since   1.6
  108.      */
  109.     protected function getListQuery()
  110.     {
  111.         // Create a new query object.
  112.         $db = $this->getDbo();
  113.         $query = $db->getQuery(true);
  114.  
  115.         // Select all fields from the languages table.
  116.         $query->select($this->getState('list.select', 'a.*', 'l.home'))
  117.             ->from($db->quoteName('#__languages') . ' AS a');
  118.  
  119.         // Join over the asset groups.
  120.         $query->select('ag.title AS access_level')
  121.             ->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
  122.  
  123.         // Select the language home pages
  124.         $query->select('l.home AS home')
  125.             ->join('LEFT', $db->quoteName('#__menu') . ' AS l  ON  l.language = a.lang_code AND l.home=1  AND l.language <> ' . $db->quote('*'));
  126.  
  127.         // Filter on the published state.
  128.         $published = $this->getState('filter.published');
  129.         if (is_numeric($published))
  130.         {
  131.             $query->where('a.published = ' . (int) $published);
  132.         }
  133.         elseif ($published === '')
  134.         {
  135.             $query->where('(a.published IN (0, 1))');
  136.         }
  137.  
  138.         // Filter by search in title
  139.         $search = $this->getState('filter.search');
  140.         if (!empty($search))
  141.         {
  142.             $search = $db->quote('%' . $db->escape($search, true) . '%', false);
  143.             $query->where('(a.title LIKE ' . $search . ')');
  144.         }
  145.  
  146.         // Filter by access level.
  147.         if ($access = $this->getState('filter.access'))
  148.         {
  149.             $query->where('a.access = ' . (int) $access);
  150.         }
  151.  
  152.         // Add the list ordering clause.
  153.         $query->order($db->escape($this->getState('list.ordering', 'a.ordering')) . ' ' . $db->escape($this->getState('list.direction', 'ASC')));
  154.  
  155.         return $query;
  156.     }
  157.  
  158.     /**
  159.      * Set the published language(s)
  160.      *
  161.      * @param   array    $cid      An array of language IDs.
  162.      * @param   integer  $value    The value of the published state.
  163.      *
  164.      * @return  boolean  True on success, false otherwise.
  165.      * @since   1.6
  166.      */
  167.     public function setPublished($cid, $value = 0)
  168.     {
  169.         return JTable::getInstance('Language')->publish($cid, $value);
  170.     }
  171.  
  172.     /**
  173.      * Method to delete records.
  174.      *
  175.      * @param   array  An array of item primary keys.
  176.      *
  177.      * @return  boolean  Returns true on success, false on failure.
  178.      * @since   1.6
  179.      */
  180.     public function delete($pks)
  181.     {
  182.         // Sanitize the array.
  183.         $pks = (array) $pks;
  184.  
  185.         // Get a row instance.
  186.         $table = JTable::getInstance('Language');
  187.  
  188.         // Iterate the items to delete each one.
  189.         foreach ($pks as $itemId)
  190.         {
  191.             if (!$table->delete((int) $itemId))
  192.             {
  193.                 $this->setError($table->getError());
  194.  
  195.                 return false;
  196.             }
  197.         }
  198.  
  199.         // Clean the cache.
  200.         $this->cleanCache();
  201.  
  202.         return true;
  203.     }
  204.  
  205.     /**
  206.      * Custom clean cache method, 2 places for 2 clients
  207.      *
  208.      * @since   1.6
  209.      */
  210.     protected function cleanCache($group = null, $client_id = 0)
  211.     {
  212.         parent::cleanCache('_system');
  213.         parent::cleanCache('com_languages');
  214.     }
  215. }

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