Source for file modulelayout.php

Documentation is available at modulelayout.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Legacy
  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. jimport('joomla.filesystem.folder');
  13.  
  14. /**
  15.  * Form Field to display a list of the layouts for module display from the module or template overrides.
  16.  *
  17.  * @package     Joomla.Legacy
  18.  * @subpackage  Form
  19.  * @since       11.1
  20.  */
  21. class JFormFieldModulelayout extends JFormField
  22. {
  23.     /**
  24.      * The form field type.
  25.      *
  26.      * @var    string 
  27.      * @since  11.1
  28.      */
  29.     protected $type = 'ModuleLayout';
  30.  
  31.     /**
  32.      * Method to get the field input for module layouts.
  33.      *
  34.      * @return  string  The field input.
  35.      *
  36.      * @since   11.1
  37.      */
  38.     protected function getInput()
  39.     {
  40.         // Get the client id.
  41.         $clientId = $this->element['client_id'];
  42.  
  43.         if (is_null($clientId) && $this->form instanceof JForm)
  44.         {
  45.             $clientId = $this->form->getValue('client_id');
  46.         }
  47.         $clientId = (int) $clientId;
  48.  
  49.         $client = JApplicationHelper::getClientInfo($clientId);
  50.  
  51.         // Get the module.
  52.         $module = (string) $this->element['module'];
  53.  
  54.         if (empty($module) && ($this->form instanceof JForm))
  55.         {
  56.             $module = $this->form->getValue('module');
  57.         }
  58.  
  59.         $module = preg_replace('#\W#', '', $module);
  60.  
  61.         // Get the template.
  62.         $template = (string) $this->element['template'];
  63.         $template = preg_replace('#\W#', '', $template);
  64.  
  65.         // Get the style.
  66.         if ($this->form instanceof JForm)
  67.         {
  68.             $template_style_id = $this->form->getValue('template_style_id');
  69.         }
  70.  
  71.         $template_style_id = preg_replace('#\W#', '', $template_style_id);
  72.  
  73.         // If an extension and view are present build the options.
  74.         if ($module && $client)
  75.         {
  76.  
  77.             // Load language file
  78.             $lang = JFactory::getLanguage();
  79.             $lang->load($module . '.sys', $client->path, null, false, true)
  80.                 || $lang->load($module . '.sys', $client->path . '/modules/' . $module, null, false, true);
  81.  
  82.             // Get the database object and a new query object.
  83.             $db = JFactory::getDbo();
  84.             $query = $db->getQuery(true);
  85.  
  86.             // Build the query.
  87.             $query->select('element, name')
  88.                 ->from('#__extensions as e')
  89.                 ->where('e.client_id = ' . (int) $clientId)
  90.                 ->where('e.type = ' . $db->quote('template'))
  91.                 ->where('e.enabled = 1');
  92.  
  93.             if ($template)
  94.             {
  95.                 $query->where('e.element = ' . $db->quote($template));
  96.             }
  97.  
  98.             if ($template_style_id)
  99.             {
  100.                 $query->join('LEFT', '#__template_styles as s on s.template=e.element')
  101.                     ->where('s.id=' . (int) $template_style_id);
  102.             }
  103.  
  104.             // Set the query and load the templates.
  105.             $db->setQuery($query);
  106.             $templates = $db->loadObjectList('element');
  107.  
  108.             // Build the search paths for module layouts.
  109.             $module_path = JPath::clean($client->path . '/modules/' . $module . '/tmpl');
  110.  
  111.             // Prepare array of component layouts
  112.             $module_layouts = array();
  113.  
  114.             // Prepare the grouped list
  115.             $groups = array();
  116.  
  117.             // Add the layout options from the module path.
  118.             if (is_dir($module_path) && ($module_layouts = JFolder::files($module_path, '^[^_]*\.php$')))
  119.             {
  120.                 // Create the group for the module
  121.                 $groups['_'] = array();
  122.                 $groups['_']['id'] = $this->id . '__';
  123.                 $groups['_']['text'] = JText::sprintf('JOPTION_FROM_MODULE');
  124.                 $groups['_']['items'] = array();
  125.  
  126.                 foreach ($module_layouts as $file)
  127.                 {
  128.                     // Add an option to the module group
  129.                     $value = basename($file, '.php');
  130.                     $text = $lang->hasKey($key = strtoupper($module . '_LAYOUT_' . $value)) ? JText::_($key) : $value;
  131.                     $groups['_']['items'][] = JHtml::_('select.option', '_:' . $value, $text);
  132.                 }
  133.             }
  134.  
  135.             // Loop on all templates
  136.             if ($templates)
  137.             {
  138.                 foreach ($templates as $template)
  139.                 {
  140.                     // Load language file
  141.                     $lang->load('tpl_' . $template->element . '.sys', $client->path, null, false, true)
  142.                         || $lang->load('tpl_' . $template->element . '.sys', $client->path . '/templates/' . $template->element, null, false, true);
  143.  
  144.                     $template_path = JPath::clean($client->path . '/templates/' . $template->element . '/html/' . $module);
  145.  
  146.                     // Add the layout options from the template path.
  147.                     if (is_dir($template_path) && ($files = JFolder::files($template_path, '^[^_]*\.php$')))
  148.                     {
  149.                         foreach ($files as $i => $file)
  150.                         {
  151.                             // Remove layout that already exist in component ones
  152.                             if (in_array($file, $module_layouts))
  153.                             {
  154.                                 unset($files[$i]);
  155.                             }
  156.                         }
  157.  
  158.                         if (count($files))
  159.                         {
  160.                             // Create the group for the template
  161.                             $groups[$template->element] = array();
  162.                             $groups[$template->element]['id'] = $this->id . '_' . $template->element;
  163.                             $groups[$template->element]['text'] = JText::sprintf('JOPTION_FROM_TEMPLATE', $template->name);
  164.                             $groups[$template->element]['items'] = array();
  165.  
  166.                             foreach ($files as $file)
  167.                             {
  168.                                 // Add an option to the template group
  169.                                 $value = basename($file, '.php');
  170.                                 $text = $lang->hasKey($key = strtoupper('TPL_' . $template->element . '_' . $module . '_LAYOUT_' . $value))
  171.                                     ? JText::_($key) : $value;
  172.                                 $groups[$template->element]['items'][] = JHtml::_('select.option', $template->element . ':' . $value, $text);
  173.                             }
  174.                         }
  175.                     }
  176.                 }
  177.             }
  178.             // Compute attributes for the grouped list
  179.             $attr = $this->element['size'] ? ' size="' . (int) $this->element['size'] . '"' : '';
  180.  
  181.             // Prepare HTML code
  182.             $html = array();
  183.  
  184.             // Compute the current selected values
  185.             $selected = array($this->value);
  186.  
  187.             // Add a grouped list
  188.             $html[] = JHtml::_(
  189.                 'select.groupedlist', $groups, $this->name,
  190.                 array('id' => $this->id, 'group.id' => 'id', 'list.attr' => $attr, 'list.select' => $selected)
  191.             );
  192.  
  193.             return implode($html);
  194.         }
  195.         else
  196.         {
  197.  
  198.             return '';
  199.         }
  200.     }
  201. }

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