Source for file templatestyle.php

Documentation is available at templatestyle.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.  * Form Field class for the Joomla CMS.
  16.  * Supports a select grouped list of template styles
  17.  *
  18.  * @package     Joomla.Libraries
  19.  * @subpackage  Form
  20.  * @since       1.6
  21.  */
  22. class JFormFieldTemplatestyle extends JFormFieldGroupedList
  23. {
  24.     /**
  25.      * The form field type.
  26.      *
  27.      * @var    string 
  28.      * @since  1.6
  29.      */
  30.     public $type = 'TemplateStyle';
  31.  
  32.     /**
  33.      * The client name.
  34.      *
  35.      * @var    mixed 
  36.      * @since  3.2
  37.      */
  38.     protected $clientName;
  39.  
  40.     /**
  41.      * The template.
  42.      *
  43.      * @var    mixed 
  44.      * @since  3.2
  45.      */
  46.     protected $template;
  47.  
  48.     /**
  49.      * Method to get certain otherwise inaccessible properties from the form field object.
  50.      *
  51.      * @param   string  $name  The property name for which to the the value.
  52.      *
  53.      * @return  mixed  The property value or null.
  54.      *
  55.      * @since   3.2
  56.      */
  57.     public function __get($name)
  58.     {
  59.         switch ($name)
  60.         {
  61.             case 'clientName':
  62.             case 'template':
  63.                 return $this->$name;
  64.         }
  65.  
  66.         return parent::__get($name);
  67.     }
  68.  
  69.     /**
  70.      * Method to set certain otherwise inaccessible properties of the form field object.
  71.      *
  72.      * @param   string  $name   The property name for which to the the value.
  73.      * @param   mixed   $value  The value of the property.
  74.      *
  75.      * @return  void 
  76.      *
  77.      * @since   3.2
  78.      */
  79.     public function __set($name, $value)
  80.     {
  81.         switch ($name)
  82.         {
  83.             case 'clientName':
  84.             case 'template':
  85.                 $this->$name = (string) $value;
  86.                 break;
  87.  
  88.             default:
  89.                 parent::__set($name, $value);
  90.         }
  91.     }
  92.  
  93.     /**
  94.      * Method to attach a JForm object to the field.
  95.      *
  96.      * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the <field /> tag for the form field object.
  97.      * @param   mixed             $value    The form field value to validate.
  98.      * @param   string            $group    The field name group control value. This acts as as an array container for the field.
  99.      *                                       For example if the field has name="foo" and the group value is set to "bar" then the
  100.      *                                       full field name would end up being "bar[foo]".
  101.      *
  102.      * @return  boolean  True on success.
  103.      *
  104.      * @see     JFormField::setup()
  105.      * @since   3.2
  106.      */
  107.     public function setup(SimpleXMLElement $element, $value, $group = null)
  108.     {
  109.         $result = parent::setup($element, $value, $group);
  110.  
  111.         if ($result == true)
  112.         {
  113.             // Get the clientName template.
  114.             $this->clientName = $this->element['client'] ? (string) $this->element['client'] : 'site';
  115.             $this->template = (string) $this->element['template'];
  116.         }
  117.  
  118.         return $result;
  119.     }
  120.  
  121.     /**
  122.      * Method to get the list of template style options grouped by template.
  123.      * Use the client attribute to specify a specific client.
  124.      * Use the template attribute to specify a specific template
  125.      *
  126.      * @return  array  The field option objects as a nested array in groups.
  127.      *
  128.      * @since   1.6
  129.      */
  130.     protected function getGroups()
  131.     {
  132.         $groups = array();
  133.         $lang = JFactory::getLanguage();
  134.  
  135.         // Get the client and client_id.
  136.         $client = JApplicationHelper::getClientInfo($this->clientName, true);
  137.  
  138.         // Get the template.
  139.         $template = $this->template;
  140.  
  141.         // Get the database object and a new query object.
  142.         $db = JFactory::getDbo();
  143.         $query = $db->getQuery(true);
  144.  
  145.         // Build the query.
  146.         $query->select('s.id, s.title, e.name as name, s.template')
  147.             ->from('#__template_styles as s')
  148.             ->where('s.client_id = ' . (int) $client->id)
  149.             ->order('template')
  150.             ->order('title');
  151.  
  152.         if ($template)
  153.         {
  154.             $query->where('s.template = ' . $db->quote($template));
  155.         }
  156.  
  157.         $query->join('LEFT', '#__extensions as e on e.element=s.template')
  158.             ->where('e.enabled = 1')
  159.             ->where($db->quoteName('e.type') . ' = ' . $db->quote('template'));
  160.  
  161.         // Set the query and load the styles.
  162.         $db->setQuery($query);
  163.         $styles = $db->loadObjectList();
  164.  
  165.         // Build the grouped list array.
  166.         if ($styles)
  167.         {
  168.             foreach ($styles as $style)
  169.             {
  170.                 $template = $style->template;
  171.                 $lang->load('tpl_' . $template . '.sys', $client->path, null, false, true)
  172.                     || $lang->load('tpl_' . $template . '.sys', $client->path . '/templates/' . $template, null, false, true);
  173.                 $name = JText::_($style->name);
  174.  
  175.                 // Initialize the group if necessary.
  176.                 if (!isset($groups[$name]))
  177.                 {
  178.                     $groups[$name] = array();
  179.                 }
  180.  
  181.                 $groups[$name][] = JHtml::_('select.option', $style->id, $style->title);
  182.             }
  183.         }
  184.  
  185.         // Merge any additional groups in the XML definition.
  186.         $groups = array_merge(parent::getGroups(), $groups);
  187.  
  188.         return $groups;
  189.     }
  190. }

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