Source for file chromestyle.php

Documentation is available at chromestyle.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Form
  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
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. JFormHelper::loadFieldClass('groupedlist');
  13.  
  14. /**
  15.  * Chrome Styles Form Field class for the Joomla Platform.
  16.  *
  17.  * @package     Joomla.Libraries
  18.  * @subpackage  Form
  19.  * @since       3.0
  20.  */
  21. class JFormFieldChromeStyle extends JFormFieldGroupedList
  22. {
  23.     /**
  24.      * The form field type.
  25.      *
  26.      * @var    string 
  27.      * @since  3.0
  28.      */
  29.     public $type = 'ChromeStyle';
  30.  
  31.     /**
  32.      * Method to get the list of template chrome style options
  33.      * grouped by template.
  34.      *
  35.      * @return  array  The field option objects as a nested array in groups.
  36.      *
  37.      * @since   3.0
  38.      */
  39.     protected function getGroups()
  40.     {
  41.         $groups = array();
  42.  
  43.         // Add Module Style Field
  44.         $tmp = '---' . JText::_('JLIB_FORM_VALUE_FROM_TEMPLATE') . '---';
  45.         $groups[$tmp][] = JHtml::_('select.option', '0', JText::_('JLIB_FORM_VALUE_INHERITED'));
  46.  
  47.         $templateStyles = $this->getTemplateModuleStyles();
  48.  
  49.         // Create one new option object for each available style, grouped by templates
  50.         foreach ($templateStyles as $template => $styles)
  51.         {
  52.             $template = ucfirst($template);
  53.             $groups[$template] = array();
  54.  
  55.             foreach ($styles as $style)
  56.             {
  57.                 $tmp = JHtml::_('select.option', $template . '-' . $style, $style);
  58.                 $groups[$template][] = $tmp;
  59.             }
  60.         }
  61.  
  62.         reset($groups);
  63.  
  64.         return $groups;
  65.     }
  66.  
  67.     /**
  68.      * Method to get the templates module styles.
  69.      *
  70.      * @return  array  The array of styles, grouped by templates.
  71.      *
  72.      * @since   3.0
  73.      */
  74.     protected function getTemplateModuleStyles()
  75.     {
  76.         $moduleStyles = array();
  77.  
  78.         $templates = array($this->getSystemTemplate());
  79.         $templates = array_merge($templates, ModulesHelper::getTemplates('site'));
  80.  
  81.         foreach ($templates as $template)
  82.         {
  83.             $modulesFilePath = JPATH_SITE . '/templates/' . $template->element . '/html/modules.php';
  84.  
  85.             // Is there modules.php for that template?
  86.             if (file_exists($modulesFilePath))
  87.             {
  88.                 $modulesFileData = file_get_contents($modulesFilePath);
  89.  
  90.                 preg_match_all('/function[\s\t]*modChrome\_([a-z0-9\-\_]*)[\s\t]*\(/i', $modulesFileData, $styles);
  91.  
  92.                 if (!array_key_exists($template->element, $moduleStyles))
  93.                 {
  94.                     $moduleStyles[$template->element] = array();
  95.                 }
  96.  
  97.                 $moduleStyles[$template->element] = $styles[1];
  98.             }
  99.         }
  100.  
  101.         return $moduleStyles;
  102.     }
  103.  
  104.     /**
  105.      * Method to get the system template as an object.
  106.      *
  107.      * @return  array  The object of system template.
  108.      *
  109.      * @since   3.0
  110.      */
  111.     protected function getSystemTemplate()
  112.     {
  113.         $template = new stdClass;
  114.         $template->element = 'system';
  115.         $template->name    = 'system';
  116.         $template->enabled = 1;
  117.  
  118.         return $template;
  119.     }
  120. }

Documentation generated on Tue, 19 Nov 2013 14:55:44 +0100 by phpDocumentor 1.4.3