Source for file templates.php

Documentation is available at templates.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_config
  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.  * Template style model.
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_config
  17.  * @since       3.2
  18.  */
  19. class ConfigModelTemplates 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.      * @since   3.2
  27.      */
  28.     protected function populateState()
  29.     {
  30.         $state = $this->loadState();
  31.  
  32.         // Load the parameters.
  33.         $params    = JComponentHelper::getParams('com_templates');
  34.         $state->set('params', $params);
  35.  
  36.         $this->setState($state);
  37.     }
  38.  
  39.     /**
  40.      * Method to get the record form.
  41.      *
  42.      * @param   array    $data      An optional array of data for the form to interogate.
  43.      * @param   boolean  $loadData  True if the form is to load its own data (default case), false if not.
  44.      *
  45.      * @return  JForm    A JForm object on success, false on failure
  46.      *
  47.      * @since   3.2
  48.      */
  49.     public function getForm($data = array(), $loadData = true)
  50.     {
  51.         // Get the form.
  52.         $form = $this->loadForm('com_config.templates', 'templates', array('control' => 'jform', 'load_data' => $loadData));
  53.  
  54.         try
  55.         {
  56.             $form = new JForm('com_config.templates');
  57.             $data = array();
  58.             $this->preprocessForm($form, $data);
  59.  
  60.             // Load the data into the form
  61.             $form->bind($data);
  62.         }
  63.         catch (Exception $e)
  64.         {
  65.             JFactory::getApplication()->enqueueMessage($e->getMessage());
  66.  
  67.             return false;
  68.         }
  69.  
  70.         if (empty($form))
  71.         {
  72.             return false;
  73.         }
  74.  
  75.         return $form;
  76.     }
  77.  
  78.     /**
  79.      * Method to preprocess the form
  80.      *
  81.      * @param   JForm   $form   A form object.
  82.      * @param   mixed   $data   The data expected for the form.
  83.      * @param   string  $group  Plugin group to load
  84.      *
  85.      * @return  void 
  86.      *
  87.      * @since   3.2
  88.      * @throws    Exception if there is an error in the form event.
  89.      */
  90.     protected function preprocessForm(JForm $form, $data, $group = 'content')
  91.     {
  92.         $lang = JFactory::getLanguage();
  93.  
  94.         $template = JFactory::getApplication()->getTemplate();
  95.  
  96.         jimport('joomla.filesystem.path');
  97.  
  98.         // Load the core and/or local language file(s).
  99.         $lang->load('tpl_' . $template, JPATH_BASE, null, false, true)
  100.         ||    $lang->load('tpl_' . $template, JPATH_BASE . '/templates/' . $template, null, false, true);
  101.  
  102.         // Look for com_config.xml, which contains fileds to display
  103.         $formFile    = JPath::clean(JPATH_BASE . '/templates/' . $template . '/com_config.xml');
  104.  
  105.         if (!file_exists($formFile))
  106.         {
  107.             // If com_config.xml not found, fall back to templateDetails.xml
  108.             $formFile    = JPath::clean(JPATH_BASE . '/templates/' . $template . '/templateDetails.xml');
  109.         }
  110.  
  111.         if (file_exists($formFile))
  112.         {
  113.             // Get the template form.
  114.             if (!$form->loadFile($formFile, false, '//config'))
  115.             {
  116.                 throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
  117.             }
  118.         }
  119.  
  120.         // Attempt to load the xml file.
  121.         if (!$xml = simplexml_load_file($formFile))
  122.         {
  123.             throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
  124.         }
  125.  
  126.         // Trigger the default form events.
  127.         parent::preprocessForm($form, $data, $group);
  128.     }
  129. }

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