Source for file language.php

Documentation is available at language.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 Component Language Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_languages
  17.  * @since       1.5
  18.  */
  19. class LanguagesModelLanguage extends JModelAdmin
  20. {
  21.     /**
  22.      * Override to get the table
  23.      *
  24.      * @return  JTable 
  25.      * @since   1.6
  26.      */
  27.     public function getTable($name = '', $prefix = '', $options = array())
  28.     {
  29.         return JTable::getInstance('Language');
  30.     }
  31.  
  32.     /**
  33.      * Method to auto-populate the model state.
  34.      *
  35.      * Note. Calling getState in this method will result in recursion.
  36.      *
  37.      * @return  void 
  38.      * @since   1.6
  39.      */
  40.     protected function populateState()
  41.     {
  42.         $app    = JFactory::getApplication('administrator');
  43.         $params = JComponentHelper::getParams('com_languages');
  44.  
  45.         // Load the User state.
  46.         $langId = $app->input->getInt('lang_id');
  47.         $this->setState('language.id', $langId);
  48.  
  49.         // Load the parameters.
  50.         $this->setState('params', $params);
  51.     }
  52.  
  53.     /**
  54.      * Method to get a member item.
  55.      *
  56.      * @param   integer    The id of the member to get.
  57.      *
  58.      * @return  mixed  User data object on success, false on failure.
  59.      * @since   1.0
  60.      */
  61.     public function getItem($langId = null)
  62.     {
  63.         $langId    = (!empty($langId)) ? $langId : (int) $this->getState('language.id');
  64.         $false  = false;
  65.  
  66.         // Get a member row instance.
  67.         $table = $this->getTable();
  68.  
  69.         // Attempt to load the row.
  70.         $return = $table->load($langId);
  71.  
  72.         // Check for a table object error.
  73.         if ($return === false && $table->getError())
  74.         {
  75.             $this->setError($table->getError());
  76.             return $false;
  77.         }
  78.  
  79.         $properties = $table->getProperties(1);
  80.         $value = JArrayHelper::toObject($properties, 'JObject');
  81.  
  82.         return $value;
  83.     }
  84.  
  85.     /**
  86.      * Method to get the group form.
  87.      *
  88.      * @param   array  $data        Data for the form.
  89.      * @param   boolean    $loadData    True if the form is to load its own data (default case), false if not.
  90.      *
  91.      * @return  mixed  A JForm object on success, false on failure
  92.      * @since   1.6
  93.      */
  94.     public function getForm($data = array(), $loadData = true)
  95.     {
  96.         // Get the form.
  97.         $form = $this->loadForm('com_languages.language', 'language', array('control' => 'jform', 'load_data' => $loadData));
  98.         if (empty($form))
  99.         {
  100.             return false;
  101.         }
  102.  
  103.         return $form;
  104.     }
  105.  
  106.     /**
  107.      * Method to get the data that should be injected in the form.
  108.      *
  109.      * @return  mixed  The data for the form.
  110.      * @since   1.6
  111.      */
  112.     protected function loadFormData()
  113.     {
  114.         // Check the session for previously entered form data.
  115.         $data = JFactory::getApplication()->getUserState('com_languages.edit.language.data', array());
  116.  
  117.         if (empty($data))
  118.         {
  119.             $data = $this->getItem();
  120.         }
  121.  
  122.         $this->preprocessData('com_languages.language', $data);
  123.  
  124.         return $data;
  125.     }
  126.  
  127.     /**
  128.      * Method to save the form data.
  129.      *
  130.      * @param   array  The form data.
  131.      *
  132.      * @return  boolean  True on success.
  133.      * @since   1.6
  134.      */
  135.     public function save($data)
  136.     {
  137.         $langId    = (int) $this->getState('language.id');
  138.         $isNew    = true;
  139.  
  140.         $dispatcher = JEventDispatcher::getInstance();
  141.         JPluginHelper::importPlugin('extension');
  142.  
  143.         $table = $this->getTable();
  144.  
  145.         // Load the row if saving an existing item.
  146.         if ($langId > 0)
  147.         {
  148.             $table->load($langId);
  149.             $isNew = false;
  150.         }
  151.  
  152.         // Bind the data
  153.         if (!$table->bind($data))
  154.         {
  155.             $this->setError($table->getError());
  156.             return false;
  157.         }
  158.  
  159.         // Check the data
  160.         if (!$table->check())
  161.         {
  162.             $this->setError($table->getError());
  163.             return false;
  164.         }
  165.  
  166.         // Trigger the onExtensionBeforeSave event.
  167.         $result = $dispatcher->trigger('onExtensionBeforeSave', array('com_languages.language', &$table, $isNew));
  168.  
  169.         // Check the event responses.
  170.         if (in_array(false, $result, true))
  171.         {
  172.             $this->setError($table->getError());
  173.             return false;
  174.         }
  175.  
  176.         // Store the data
  177.         if (!$table->store())
  178.         {
  179.             $this->setError($table->getError());
  180.             return false;
  181.         }
  182.  
  183.         // Trigger the onExtensionAfterSave event.
  184.         $dispatcher->trigger('onExtensionAfterSave', array('com_languages.language', &$table, $isNew));
  185.  
  186.         $this->setState('language.id', $table->lang_id);
  187.  
  188.         // Clean the cache.
  189.         $this->cleanCache();
  190.  
  191.         return true;
  192.     }
  193.  
  194.     /**
  195.      * Custom clean cache method
  196.      *
  197.      * @since   1.6
  198.      */
  199.     protected function cleanCache($group = null, $client_id = 0)
  200.     {
  201.         parent::cleanCache('_system');
  202.         parent::cleanCache('com_languages');
  203.     }
  204. }

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