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

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.