Source for file component.php

Documentation is available at component.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_config
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2012 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.  * Model for component configuration
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_config
  17.  * @since       3.2
  18.  */
  19. class ConfigModelComponent extends ConfigModelForm
  20. {
  21.     /**
  22.      * Method to auto-populate the model state.
  23.      *
  24.      * Note. Calling getState in this method will result in recursion.
  25.      *
  26.      * @return    void 
  27.      *
  28.      * @since    3.2
  29.      */
  30.     protected function populateState()
  31.     {
  32.         $input = JFactory::getApplication()->input;
  33.  
  34.         // Set the component (option) we are dealing with.
  35.         $component = $input->get('component');
  36.         $state = $this->loadState();
  37.         $state->set('component.option', $component);
  38.  
  39.         // Set an alternative path for the configuration file.
  40.         if ($path = $input->getString('path'))
  41.         {
  42.             $path = JPath::clean(JPATH_SITE . '/' . $path);
  43.             JPath::check($path);
  44.             $state->set('component.path', $path);
  45.         }
  46.  
  47.         $this->setState($state);
  48.     }
  49.  
  50.     /**
  51.      * Method to get a form object.
  52.      *
  53.      * @param   array    $data      Data for the form.
  54.      * @param   boolean  $loadData  True if the form is to load its own data (default case), false if not.
  55.      *
  56.      * @return  mixed  A JForm object on success, false on failure
  57.      *
  58.      * @since    3.2
  59.      */
  60.     public function getForm($data = array(), $loadData = true)
  61.     {
  62.         $state = $this->getState();
  63.  
  64.         if ($path = $state->get('component.path'))
  65.         {
  66.             // Add the search path for the admin component config.xml file.
  67.             JForm::addFormPath($path);
  68.         }
  69.         else
  70.         {
  71.             // Add the search path for the admin component config.xml file.
  72.             JForm::addFormPath(JPATH_ADMINISTRATOR . '/components/' . $state->get('component.option'));
  73.         }
  74.  
  75.         // Get the form.
  76.         $form = $this->loadForm(
  77.             'com_config.component',
  78.             'config',
  79.             array('control' => 'jform', 'load_data' => $loadData),
  80.             false,
  81.             '/config'
  82.         );
  83.  
  84.         if (empty($form))
  85.         {
  86.  
  87.             return false;
  88.         }
  89.  
  90.         return $form;
  91.     }
  92.  
  93.     /**
  94.      * Get the component information.
  95.      *
  96.      * @return    object 
  97.      *
  98.      * @since    3.2
  99.      */
  100.     public function getComponent()
  101.     {
  102.         $state = $this->getState();
  103.         $option = $state->get('component.option');
  104.  
  105.         // Load common and local language files.
  106.         $lang = JFactory::getLanguage();
  107.             $lang->load($option, JPATH_BASE, null, false, true)
  108.         ||    $lang->load($option, JPATH_BASE . "/components/$option", null, false, true);
  109.  
  110.         $result = JComponentHelper::getComponent($option);
  111.  
  112.         return $result;
  113.     }
  114.  
  115.     /**
  116.      * Method to save the configuration data.
  117.      *
  118.      * @param   array  $data  An array containing all global config data.
  119.      *
  120.      * @return  boolean  True on success, false on failure.
  121.      *
  122.      * @since    3.2
  123.      * @throws  RuntimeException
  124.      */
  125.     public function save($data)
  126.     {
  127.         $table    = JTable::getInstance('extension');
  128.  
  129.         // Save the rules.
  130.         if (isset($data['params']) && isset($data['params']['rules']))
  131.         {
  132.             $rules = new JAccessRules($data['params']['rules']);
  133.             $asset = JTable::getInstance('asset');
  134.  
  135.             if (!$asset->loadByName($data['option']))
  136.             {
  137.                 $root = JTable::getInstance('asset');
  138.                 $root->loadByName('root.1');
  139.                 $asset->name = $data['option'];
  140.                 $asset->title = $data['option'];
  141.                 $asset->setLocation($root->id, 'last-child');
  142.             }
  143.  
  144.             $asset->rules = (string) $rules;
  145.  
  146.             if (!$asset->check() || !$asset->store())
  147.             {
  148.                 throw new RuntimeException($table->getError());
  149.             }
  150.  
  151.             // We don't need this anymore
  152.             unset($data['option']);
  153.             unset($data['params']['rules']);
  154.         }
  155.  
  156.         // Load the previous Data
  157.         if (!$table->load($data['id']))
  158.         {
  159.             throw new RuntimeException($table->getError());
  160.         }
  161.  
  162.         unset($data['id']);
  163.  
  164.         // Bind the data.
  165.         if (!$table->bind($data))
  166.         {
  167.             throw new RuntimeException($table->getError());
  168.         }
  169.  
  170.         // Check the data.
  171.         if (!$table->check())
  172.         {
  173.             throw new RuntimeException($table->getError());
  174.         }
  175.  
  176.         // Store the data.
  177.         if (!$table->store())
  178.         {
  179.             throw new RuntimeException($table->getError());
  180.         }
  181.  
  182.         // Clean the component cache.
  183.         $this->cleanCache('_system');
  184.  
  185.         return true;
  186.     }
  187. }

Documentation generated on Tue, 19 Nov 2013 14:56:15 +0100 by phpDocumentor 1.4.3