/**
* Method to get the field input for a component layout field.
*
* @return string The field input.
*/
protected function getInput()
{
// Initialize variables.
// Get the client id.
$clientId = $this->element['client_id'];
if (is_null($clientId) && $this->form instanceof Form) {
$clientId = $this->form->getValue('client_id');
}
$clientId = (int) $clientId;
$client = ClientManager::client($clientId);
// Get the extension.
$extn = (string) $this->element['extension'];
if (empty($extn) && $this->form instanceof Form) {
$extn = $this->form->getValue('extension');
}
$extn = preg_replace('#\\W#', '', $extn);
// Get the template.
$template = (string) $this->element['template'];
$template = preg_replace('#\\W#', '', $template);
// Get the style.
if ($this->form instanceof Form) {
$template_style_id = $this->form->getValue('template_style_id');
}
$template_style_id = preg_replace('#\\W#', '', $template_style_id);
// Get the view.
$view = (string) $this->element['view'];
$view = preg_replace('#\\W#', '', $view);
// If a template, extension and view are present build the options.
if ($extn && $view && $client) {
// Load language file
$lang = App::get('language');
$lang->load($extn . '.sys', App::get('component')->path($extn) . '/admin', null, false, true);
// Get the database object and a new query object.
$db = App::get('db');
$query = $db->getQuery(true);
// Build the query.
$query->select('e.element, e.name');
$query->from('#__extensions as e');
$query->where('e.client_id = ' . (int) $clientId);
$query->where('e.type = ' . $db->quote('template'));
$query->where('e.enabled = 1');
if ($template) {
$query->where('e.element = ' . $db->quote($template));
}
if ($template_style_id) {
$query->join('LEFT', '#__template_styles as s on s.template=e.element');
$query->where('s.id=' . (int) $template_style_id);
}
// Set the query and load the templates.
$db->setQuery($query);
$templates = $db->loadObjectList('element');
// Check for a database error.
if ($db->getErrorNum()) {
throw new Exception(500, $db->getErrorMsg());
}
$filesystem = App::get('filesystem');
// Build the search paths for component layouts.
$component_path = Util::normalizePath($client->path . '/components/' . $extn . '/views/' . $view . '/tmpl');
// Prepare array of component layouts
$component_layouts = array();
// Prepare the grouped list
$groups = array();
// Add a Use Global option if useglobal="true" in XML file
if ($this->element['useglobal'] == 'true') {
$groups[$lang->txt('JOPTION_FROM_STANDARD')]['items'][] = Dropdown::option('', $lang->txt('JGLOBAL_USE_GLOBAL'));
}
// Add the layout options from the component path.
if (is_dir($component_path) && ($component_layouts = $filesystem->files($component_path, '^[^_]*\\.xml$', false, true))) {
// Create the group for the component
$groups['_'] = array();
$groups['_']['id'] = $this->id . '__';
$groups['_']['text'] = $lang->txt('JOPTION_FROM_COMPONENT');
$groups['_']['items'] = array();
foreach ($component_layouts as $i => $file) {
// Attempt to load the XML file.
if (!($xml = simplexml_load_file($file))) {
unset($component_layouts[$i]);
continue;
}
// Get the help data from the XML file if present.
if (!($menu = $xml->xpath('layout[1]'))) {
unset($component_layouts[$i]);
continue;
}
$menu = $menu[0];
// Add an option to the component group
$value = $filesystem->name($file);
$component_layouts[$i] = $value;
$text = isset($menu['option']) ? $lang->txt($menu['option']) : (isset($menu['title']) ? $lang->txt($menu['title']) : $value);
$groups['_']['items'][] = Dropdown::option('_:' . $value, $text);
}
}
// Loop on all templates
if ($templates) {
foreach ($templates as $template) {
// Load language file
$lang->load('tpl_' . $template->element . '.sys', $client->path, null, false, true) || $lang->load('tpl_' . $template->element . '.sys', $client->path . '/templates/' . $template->element, null, false, true);
$template_path = Util::normalizePath($client->path . '/templates/' . $template->element . '/html/' . $extn . '/' . $view);
// Add the layout options from the template path.
if (is_dir($template_path) && ($files = $filesystem->files($template_path, '^[^_]*\\.php$', false, true))) {
// Files with corresponding XML files are alternate menu items, not alternate layout files
// so we need to exclude these files from the list.
$xml_files = $filesystem->files($template_path, '^[^_]*\\.xml$', false, true);
for ($j = 0, $count = count($xml_files); $j < $count; $j++) {
$xml_files[$j] = $filesystem->name($xml_files[$j]);
}
foreach ($files as $i => $file) {
// Remove layout files that exist in the component folder or that have XML files
if (in_array($filesystem->name($file), $component_layouts) || in_array($filesystem->name($file), $xml_files)) {
unset($files[$i]);
}
}
if (count($files)) {
// Create the group for the template
$groups[$template->name] = array();
$groups[$template->name]['id'] = $this->id . '_' . $template->element;
$groups[$template->name]['text'] = $lang->txt('JOPTION_FROM_TEMPLATE', $template->name);
$groups[$template->name]['items'] = array();
foreach ($files as $file) {
// Add an option to the template group
$value = $filesystem->name($file);
$text = $lang->hasKey($key = strtoupper('TPL_' . $template->name . '_' . $extn . '_' . $view . '_LAYOUT_' . $value)) ? $lang->txt($key) : $value;
$groups[$template->name]['items'][] = Dropdown::option($template->element . ':' . $value, $text);
}
}
}
}
}
// Compute attributes for the grouped list
$attr = $this->element['size'] ? ' size="' . (int) $this->element['size'] . '"' : '';
// Prepare HTML code
$html = array();
// Compute the current selected values
$selected = array($this->value);
// Add a grouped list
$html[] = Dropdown::groupedlist($groups, $this->name, array('id' => $this->id, 'group.id' => 'id', 'list.attr' => $attr, 'list.select' => $selected));
return implode($html);
}
return '';
}
/**
* Method to get the field input for module layouts.
*
* @return string The field input.
*/
protected function getInput()
{
// Get the client id.
$clientId = $this->element['client_id'];
if (is_null($clientId) && $this->form instanceof Form) {
$clientId = $this->form->getValue('client_id');
}
$clientId = (int) $clientId;
$client = ClientManager::client($clientId);
// Get the module.
$module = (string) $this->element['module'];
if (empty($module) && $this->form instanceof Form) {
$module = $this->form->getValue('module');
}
$module = preg_replace('#\\W#', '', $module);
// Get the template.
$template = (string) $this->element['template'];
$template = preg_replace('#\\W#', '', $template);
// Get the style.
if ($this->form instanceof Form) {
$template_style_id = $this->form->getValue('template_style_id');
}
$template_style_id = preg_replace('#\\W#', '', $template_style_id);
// If an extension and view are present build the options.
if ($module && $client) {
// Load language file
$lang = App::get('language');
$lang->load($module . '.sys', $client->path, null, false, true) || $lang->load($module . '.sys', $client->path . '/modules/' . $module, null, false, true);
// Get the database object and a new query object.
$db = App::get('db');
$query = $db->getQuery(true);
// Build the query.
$query->select('element, name');
$query->from('#__extensions as e');
$query->where('e.client_id = ' . (int) $clientId);
$query->where('e.type = ' . $db->quote('template'));
$query->where('e.enabled = 1');
if ($template) {
$query->where('e.element = ' . $db->quote($template));
}
if ($template_style_id) {
$query->join('LEFT', '#__template_styles as s on s.template=e.element');
$query->where('s.id=' . (int) $template_style_id);
}
// Set the query and load the templates.
$db->setQuery($query);
$templates = $db->loadObjectList('element');
// Check for a database error.
if ($db->getErrorNum()) {
App::abort(500, $db->getErrorMsg());
}
// Build the search paths for module layouts.
$module_path = Util::normalizePath($client->path . '/modules/' . $module . '/tmpl');
// Prepare array of component layouts
$module_layouts = array();
// Prepare the grouped list
$groups = array();
// Add the layout options from the module path.
if (is_dir($module_path) && ($module_layouts = App::get('filesystem')->files($module_path, '^[^_]*\\.php$'))) {
// Create the group for the module
$groups['_'] = array();
$groups['_']['id'] = $this->id . '__';
$groups['_']['text'] = $lang->txt('JOPTION_FROM_MODULE');
$groups['_']['items'] = array();
foreach ($module_layouts as $file) {
// Add an option to the module group
$value = App::get('filesystem')->name($file);
$text = $lang->hasKey($key = strtoupper($module . '_LAYOUT_' . $value)) ? JText::_($key) : $value;
$groups['_']['items'][] = Dropdown::option('_:' . $value, $text);
}
}
// Loop on all templates
if ($templates) {
foreach ($templates as $template) {
// Load language file
$lang->load('tpl_' . $template->element . '.sys', $client->path, null, false, true) || $lang->load('tpl_' . $template->element . '.sys', $client->path . '/templates/' . $template->element, null, false, true);
$template_path = Util::normalizePath($client->path . '/templates/' . $template->element . '/html/' . $module);
// Add the layout options from the template path.
if (is_dir($template_path) && ($files = App::get('filesystem')->files($template_path, '^[^_]*\\.php$'))) {
foreach ($files as $i => $file) {
// Remove layout that already exist in component ones
if (in_array($file, $module_layouts)) {
unset($files[$i]);
}
}
if (count($files)) {
// Create the group for the template
$groups[$template->element] = array();
$groups[$template->element]['id'] = $this->id . '_' . $template->element;
$groups[$template->element]['text'] = $lang->txt('JOPTION_FROM_TEMPLATE', $template->name);
$groups[$template->element]['items'] = array();
foreach ($files as $file) {
// Add an option to the template group
$value = App::get('filesystem')->name($file);
$text = $lang->hasKey($key = strtoupper('TPL_' . $template->element . '_' . $module . '_LAYOUT_' . $value)) ? $lang->txt($key) : $value;
$groups[$template->element]['items'][] = Dropdown::option($template->element . ':' . $value, $text);
}
}
}
}
}
// Compute attributes for the grouped list
$attr = $this->element['size'] ? ' size="' . (int) $this->element['size'] . '"' : '';
// Prepare HTML code
$html = array();
// Compute the current selected values
$selected = array($this->value);
// Add a grouped list
$html[] = Dropdown::groupedlist($groups, $this->name, array('id' => $this->id, 'group.id' => 'id', 'list.attr' => $attr, 'list.select' => $selected));
return implode($html);
}
return '';
}
/**
* Method to get the field input markup fora grouped list.
* Multiselect is enabled by using the multiple attribute.
*
* @return string The field input markup.
*/
protected function getInput()
{
// Initialize variables.
$html = array();
$attr = '';
// Initialize some field attributes.
$attr .= $this->element['class'] ? ' class="' . (string) $this->element['class'] . '"' : '';
$attr .= (string) $this->element['disabled'] == 'true' ? ' disabled="disabled"' : '';
$attr .= $this->element['size'] ? ' size="' . (int) $this->element['size'] . '"' : '';
$attr .= $this->multiple ? ' multiple="multiple"' : '';
// Initialize JavaScript field attributes.
$attr .= $this->element['onchange'] ? ' onchange="' . (string) $this->element['onchange'] . '"' : '';
// Get the field groups.
$groups = (array) $this->getGroups();
// Create a read-only list (no name) with a hidden input to store the value.
if ((string) $this->element['readonly'] == 'true') {
$html[] = Dropdown::groupedlist($groups, null, array('list.attr' => $attr, 'id' => $this->id, 'list.select' => $this->value, 'group.items' => null, 'option.key.toHtml' => false, 'option.text.toHtml' => false));
$html[] = '<input type="hidden" name="' . $this->name . '" value="' . htmlspecialchars($this->value, ENT_COMPAT, 'UTF-8') . '"/>';
} else {
$html[] = Dropdown::groupedlist($groups, $this->name, array('list.attr' => $attr, 'id' => $this->id, 'list.select' => $this->value, 'group.items' => null, 'option.key.toHtml' => false, 'option.text.toHtml' => false));
}
return implode($html);
}
