Source for file override.php

Documentation is available at override.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 Override Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_languages
  17.  * @since       2.5
  18.  */
  19. class LanguagesModelOverride extends JModelAdmin
  20. {
  21.     /**
  22.      * Method to get the record form.
  23.      *
  24.      * @param       array        $data            Data for the form.
  25.      * @param       boolean    $loadData    True if the form is to load its own data (default case), false if not.
  26.      *
  27.      * @return  mixed      A JForm object on success, false on failure
  28.      *
  29.      * @since        2.5
  30.      */
  31.     public function getForm($data = array(), $loadData = true)
  32.     {
  33.         // Get the form
  34.         $form = $this->loadForm('com_languages.override', 'override', array('control' => 'jform', 'load_data' => $loadData));
  35.         if (empty($form))
  36.         {
  37.             return false;
  38.         }
  39.  
  40.         $client        = $this->getState('filter.client', 'site');
  41.         $language    = $this->getState('filter.language', 'en-GB');
  42.         $langName    = JLanguage::getInstance($language)->getName();
  43.         if (!$langName)
  44.         {
  45.             // If a language only exists in frontend, it's meta data cannot be
  46.             // loaded in backend at the moment, so fall back to the language tag
  47.             $langName = $language;
  48.         }
  49.         $form->setValue('client', null, JText::_('COM_LANGUAGES_VIEW_OVERRIDE_CLIENT_'.strtoupper($client)));
  50.         $form->setValue('language', null, JText::sprintf('COM_LANGUAGES_VIEW_OVERRIDE_LANGUAGE', $langName, $language));
  51.         $form->setValue('file', null, JPath::clean(constant('JPATH_'.strtoupper($client)) . '/language/overrides/' . $language . '.override.ini'));
  52.  
  53.         return $form;
  54.     }
  55.  
  56.     /**
  57.      * Method to get the data that should be injected in the form.
  58.      *
  59.      * @return  mixed The data for the form
  60.      *
  61.      * @since        2.5
  62.      */
  63.     protected function loadFormData()
  64.     {
  65.         // Check the session for previously entered form data.
  66.         $data = JFactory::getApplication()->getUserState('com_languages.edit.override.data', array());
  67.  
  68.         if (empty($data))
  69.         {
  70.             $data = $this->getItem();
  71.         }
  72.  
  73.         $this->preprocessData('com_languages.override', $data);
  74.  
  75.         return $data;
  76.     }
  77.  
  78.     /**
  79.      * Method to get a single record.
  80.      *
  81.      * @param       string    $pk    The key name.
  82.      *
  83.      * @return  mixed      Object on success, false otherwise.
  84.      *
  85.      * @since        2.5
  86.      */
  87.     public function getItem($pk = null)
  88.     {
  89.         require_once JPATH_COMPONENT.'/helpers/languages.php';
  90.  
  91.         $input = JFactory::getApplication()->input;
  92.         $pk    = (!empty($pk)) ? $pk : $input->get('id');
  93.         $filename = constant('JPATH_'.strtoupper($this->getState('filter.client'))) . '/language/overrides/' . $this->getState('filter.language', 'en-GB').'.override.ini';
  94.         $strings = LanguagesHelper::parseFile($filename);
  95.  
  96.         $result = new stdClass;
  97.         $result->key      = '';
  98.         $result->override = '';
  99.         if (isset($strings[$pk]))
  100.         {
  101.             $result->key      = $pk;
  102.             $result->override = $strings[$pk];
  103.         }
  104.  
  105.         return $result;
  106.     }
  107.  
  108.     /**
  109.      * Method to save the form data.
  110.      *
  111.      * @param       array        $data                            The form data.
  112.      * @param       boolean    $opposite_client    Indicates whether the override should not be created for the current client
  113.      *
  114.      * @return  boolean  True on success, false otherwise.
  115.      *
  116.      * @since        2.5
  117.      */
  118.     public function save($data, $opposite_client = false)
  119.     {
  120.         $app = JFactory::getApplication();
  121.         require_once JPATH_COMPONENT.'/helpers/languages.php';
  122.         jimport('joomla.filesystem.file');
  123.  
  124.         $client        = $app->getUserState('com_languages.overrides.filter.client', 0);
  125.         $language    = $app->getUserState('com_languages.overrides.filter.language', 'en-GB');
  126.  
  127.         // If the override should be created for both
  128.         if ($opposite_client)
  129.         {
  130.             $client = 1 - $client;
  131.         }
  132.  
  133.         $client = $client ? 'administrator' : 'site';
  134.  
  135.         // Parse the override.ini file in oder to get the keys and strings
  136.         $filename    = constant('JPATH_'.strtoupper($client)) . '/language/overrides/' . $language . '.override.ini';
  137.         $strings    = LanguagesHelper::parseFile($filename);
  138.  
  139.         if (isset($strings[$data['id']]))
  140.         {
  141.             // If an existent string was edited check whether
  142.             // the name of the constant is still the same
  143.             if ($data['key'] == $data['id'])
  144.             {
  145.                 // If yes, simply override it
  146.                 $strings[$data['key']] = $data['override'];
  147.             }
  148.             else
  149.             {
  150.                 // If no, delete the old string and prepend the new one
  151.                 unset($strings[$data['id']]);
  152.                 $strings = array($data['key'] => $data['override']) + $strings;
  153.             }
  154.         }
  155.         else
  156.         {
  157.             // If it is a new override simply prepend it
  158.             $strings = array($data['key'] => $data['override']) + $strings;
  159.         }
  160.  
  161.         foreach ($strings as $key => $string)
  162.         {
  163.             $strings[$key] = str_replace('"', '"_QQ_"', $string);
  164.         }
  165.  
  166.         // Write override.ini file with the strings
  167.         $registry = new JRegistry;
  168.         $registry->loadObject($strings);
  169.         $reg = $registry->toString('INI');
  170.  
  171.         if (!JFile::write($filename, $reg))
  172.         {
  173.             return false;
  174.         }
  175.  
  176.         // If the override should be stored for both clients save
  177.         // it also for the other one and prevent endless recursion
  178.         if (isset($data['both']) && $data['both'] && !$opposite_client)
  179.         {
  180.             return $this->save($data, true);
  181.         }
  182.  
  183.         return true;
  184.     }
  185.  
  186.     /**
  187.      * Method to auto-populate the model state.
  188.      *
  189.      * Note. Calling getState in this method will result in recursion.
  190.      *
  191.      * @return  void 
  192.      *
  193.      * @since        2.5
  194.      */
  195.     protected function populateState()
  196.     {
  197.         $app = JFactory::getApplication();
  198.  
  199.         $client = $app->getUserStateFromRequest('com_languages.overrides.filter.client', 'filter_client', 0, 'int') ? 'administrator' : 'site';
  200.         $this->setState('filter.client', $client);
  201.  
  202.         $language = $app->getUserStateFromRequest('com_languages.overrides.filter.language', 'filter_language', 'en-GB', 'cmd');
  203.         $this->setState('filter.language', $language);
  204.     }
  205. }

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