Source for file overrides.php

Documentation is available at overrides.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 Overrides Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_languages
  17.  * @since       2.5
  18.  */
  19. class LanguagesModelOverrides extends JModelList
  20. {
  21.     /**
  22.      * Constructor
  23.      *
  24.      * @param       array    An optional associative array of configuration settings
  25.      *
  26.      * @return  void 
  27.      *
  28.      * @since        2.5
  29.      */
  30.     public function __construct($config = array())
  31.     {
  32.         parent::__construct($config);
  33.  
  34.         $this->filter_fields = array('key', 'text');
  35.     }
  36.  
  37.     /**
  38.      * Retrieves the overrides data
  39.      *
  40.      * @param   boolean  $all  True if all overrides shall be returned without considering pagination, defaults to false
  41.      *
  42.      * @return  array  Array of objects containing the overrides of the override.ini file
  43.      *
  44.      * @since   2.5
  45.      */
  46.     public function getOverrides($all = false)
  47.     {
  48.         // Get a storage key
  49.         $store = $this->getStoreId();
  50.  
  51.         // Try to load the data from internal storage
  52.         if (!empty($this->cache[$store]))
  53.         {
  54.             return $this->cache[$store];
  55.         }
  56.  
  57.         $client = in_array($this->state->get('filter.client'), array(0, 'site')) ? strtoupper('site') : strtoupper('administrator');
  58.  
  59.         // Parse the override.ini file in order to get the keys and strings
  60.         $filename = constant('JPATH_' . $client) . '/language/overrides/' . $this->getState('filter.language') . '.override.ini';
  61.         $strings = LanguagesHelper::parseFile($filename);
  62.  
  63.         // Filter the loaded strings according to the search box
  64.         $search = $this->getState('filter.search');
  65.  
  66.         if ($search != '')
  67.         {
  68.             $search = preg_quote($search, '~');
  69.             $matchvals = preg_grep('~' . $search . '~i', $strings);
  70.             $matchkeys = array_intersect_key($strings, array_flip(preg_grep('~' . $search . '~i',  array_keys($strings))));
  71.             $strings = array_merge($matchvals, $matchkeys);
  72.         }
  73.  
  74.         // Consider the odering
  75.         if ($this->getState('list.ordering') == 'text')
  76.         {
  77.             if (strtoupper($this->getState('list.direction')) == 'DESC')
  78.             {
  79.                 arsort($strings);
  80.             }
  81.             else
  82.             {
  83.                 asort($strings);
  84.             }
  85.         }
  86.         else
  87.         {
  88.             if (strtoupper($this->getState('list.direction')) == 'DESC')
  89.             {
  90.                 krsort($strings);
  91.             }
  92.             else
  93.             {
  94.                 ksort($strings);
  95.             }
  96.         }
  97.  
  98.         // Consider the pagination
  99.         if (!$all && $this->getState('list.limit') && $this->getTotal() > $this->getState('list.limit'))
  100.         {
  101.             $strings = array_slice($strings, $this->getStart(), $this->getState('list.limit'), true);
  102.         }
  103.  
  104.         // Add the items to the internal cache
  105.         $this->cache[$store] = $strings;
  106.  
  107.         return $this->cache[$store];
  108.     }
  109.  
  110.     /**
  111.      * Method to get the total number of overrides
  112.      *
  113.      * @return  int    The total number of overrides
  114.      *
  115.      * @since        2.5
  116.      */
  117.     public function getTotal()
  118.     {
  119.         // Get a storage key
  120.         $store = $this->getStoreId('getTotal');
  121.  
  122.         // Try to load the data from internal storage
  123.         if (!empty($this->cache[$store]))
  124.         {
  125.             return $this->cache[$store];
  126.         }
  127.  
  128.         // Add the total to the internal cache
  129.         $this->cache[$store] = count($this->getOverrides(true));
  130.  
  131.         return $this->cache[$store];
  132.     }
  133.  
  134.     /**
  135.      * Method to auto-populate the model state.
  136.      *
  137.      * Note. Calling getState in this method will result in recursion.
  138.      *
  139.      * @param   string  $ordering   An optional ordering field.
  140.      * @param   string  $direction  An optional direction (asc|desc).
  141.      *
  142.      * @return  void 
  143.      *
  144.      * @since   2.5
  145.      */
  146.     protected function populateState($ordering = null, $direction = null)
  147.     {
  148.         $app = JFactory::getApplication();
  149.  
  150.         // Use default language of frontend for default filter
  151.         $default = JComponentHelper::getParams('com_languages')->get('site').'0';
  152.  
  153.         $old_language_client = $app->getUserState('com_languages.overrides.filter.language_client', '');
  154.         $language_client     = $this->getUserStateFromRequest('com_languages.overrides.filter.language_client', 'filter_language_client', $default, 'cmd');
  155.  
  156.         if ($old_language_client != $language_client)
  157.         {
  158.             $client   = substr($language_client, -1);
  159.             $language = substr($language_client, 0, -1);
  160.         }
  161.         else
  162.         {
  163.             $client   = $app->getUserState('com_languages.overrides.filter.client', 0);
  164.             $language = $app->getUserState('com_languages.overrides.filter.language', 'en-GB');
  165.         }
  166.  
  167.         // Sets the search filter
  168.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  169.         $this->setState('filter.search', $search);
  170.  
  171.         $this->setState('filter.language_client', $language.$client);
  172.         $this->setState('filter.client', $client ? 'administrator' : 'site');
  173.         $this->setState('filter.language', $language);
  174.  
  175.         // Add filters to the session because they won't be stored there by 'getUserStateFromRequest' if they aren't in the current request
  176.         $app->setUserState('com_languages.overrides.filter.client', $client);
  177.         $app->setUserState('com_languages.overrides.filter.language', $language);
  178.  
  179.         // List state information
  180.         parent::populateState('key', 'asc');
  181.     }
  182.  
  183.     /**
  184.      * Method to get all found languages of frontend and backend.
  185.      *
  186.      * The resulting array has entries of the following style:
  187.      * <Language Tag>0|1 => <Language Name> - <Client Name>
  188.      *
  189.      * @return  array  Sorted associative array of languages
  190.      *
  191.      * @since        2.5
  192.      */
  193.     public function getLanguages()
  194.     {
  195.         // Try to load the data from internal storage
  196.         if (!empty($this->cache['languages']))
  197.         {
  198.             return $this->cache['languages'];
  199.         }
  200.  
  201.         // Get all languages of frontend and backend
  202.         $languages                 = array();
  203.         $site_languages     = JLanguage::getKnownLanguages(JPATH_SITE);
  204.         $admin_languages    = JLanguage::getKnownLanguages(JPATH_ADMINISTRATOR);
  205.  
  206.         // Create a single array of them
  207.         foreach ($site_languages as $tag => $language)
  208.         {
  209.             $languages[$tag.'0'] = JText::sprintf('COM_LANGUAGES_VIEW_OVERRIDES_LANGUAGES_BOX_ITEM', $language['name'], JText::_('JSITE'));
  210.         }
  211.         foreach ($admin_languages as $tag => $language)
  212.         {
  213.             $languages[$tag.'1'] = JText::sprintf('COM_LANGUAGES_VIEW_OVERRIDES_LANGUAGES_BOX_ITEM', $language['name'], JText::_('JADMINISTRATOR'));
  214.         }
  215.  
  216.         // Sort it by language tag and by client after that
  217.         ksort($languages);
  218.  
  219.         // Add the languages to the internal cache
  220.         $this->cache['languages'] = $languages;
  221.  
  222.         return $this->cache['languages'];
  223.     }
  224.  
  225.     /**
  226.      * Method to delete one or more overrides
  227.      *
  228.      * @param       array        Array of keys to delete
  229.      *
  230.      * @return  integer       Number of successfully deleted overrides, boolean false if an error occured
  231.      *
  232.      * @since        2.5
  233.      */
  234.     public function delete($cids)
  235.     {
  236.         // Check permissions first
  237.         if (!JFactory::getUser()->authorise('core.delete', 'com_languages'))
  238.         {
  239.             $this->setError(JText::_('JLIB_APPLICATION_ERROR_DELETE_NOT_PERMITTED'));
  240.  
  241.             return false;
  242.         }
  243.  
  244.         jimport('joomla.filesystem.file');
  245.         require_once JPATH_COMPONENT.'/helpers/languages.php';
  246.  
  247.         $client = in_array($this->state->get('filter.client'), array(0, 'site')) ? strtoupper('site') : strtoupper('administrator');
  248.  
  249.         // Parse the override.ini file in oder to get the keys and strings
  250.         $filename = constant('JPATH_' . $client) . '/language/overrides/' . $this->getState('filter.language') . '.override.ini';
  251.         $strings = LanguagesHelper::parseFile($filename);
  252.  
  253.         // Unset strings that shall be deleted
  254.         foreach ($cids as $key)
  255.         {
  256.             if (isset($strings[$key]))
  257.             {
  258.                 unset($strings[$key]);
  259.             }
  260.         }
  261.  
  262.         foreach ($strings as $key => $string)
  263.         {
  264.             $strings[$key] = str_replace('"', '"_QQ_"', $string);
  265.         }
  266.  
  267.         // Write override.ini file with the left strings
  268.         $registry = new JRegistry;
  269.         $registry->loadObject($strings);
  270.         $reg = $registry->toString('INI');
  271.  
  272.         $filename = constant('JPATH_' . $client) . '/language/overrides/' . $this->getState('filter.language') . '.override.ini';
  273.  
  274.         if (!JFile::write($filename, $reg))
  275.         {
  276.             return false;
  277.         }
  278.  
  279.         $this->cleanCache();
  280.  
  281.         return count($cids);
  282.     }
  283. }

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