Source for file templates.php

Documentation is available at templates.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_templates
  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.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * Templates component helper.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_templates
  17.  * @since       1.6
  18.  */
  19. class TemplatesHelper
  20. {
  21.     /**
  22.      * Configure the Linkbar.
  23.      *
  24.      * @param   string  $vName  The name of the active view.
  25.      *
  26.      * @return  void 
  27.      */
  28.     public static function addSubmenu($vName)
  29.     {
  30.         JHtmlSidebar::addEntry(
  31.             JText::_('COM_TEMPLATES_SUBMENU_STYLES'),
  32.             'index.php?option=com_templates&view=styles',
  33.             $vName == 'styles'
  34.         );
  35.         JHtmlSidebar::addEntry(
  36.             JText::_('COM_TEMPLATES_SUBMENU_TEMPLATES'),
  37.             'index.php?option=com_templates&view=templates',
  38.             $vName == 'templates'
  39.         );
  40.     }
  41.  
  42.     /**
  43.      * Gets a list of the actions that can be performed.
  44.      *
  45.      * @return  JObject 
  46.      */
  47.     public static function getActions()
  48.     {
  49.         $user = JFactory::getUser();
  50.         $result = new JObject;
  51.  
  52.         $actions = JAccess::getActions('com_templates');
  53.  
  54.         foreach ($actions as $action)
  55.         {
  56.             $result->set($action->name, $user->authorise($action->name, 'com_templates'));
  57.         }
  58.  
  59.         return $result;
  60.     }
  61.  
  62.     /**
  63.      * Get a list of filter options for the application clients.
  64.      *
  65.      * @return  array  An array of JHtmlOption elements.
  66.      */
  67.     public static function getClientOptions()
  68.     {
  69.         // Build the filter options.
  70.         $options = array();
  71.         $options[] = JHtml::_('select.option', '0', JText::_('JSITE'));
  72.         $options[] = JHtml::_('select.option', '1', JText::_('JADMINISTRATOR'));
  73.  
  74.         return $options;
  75.     }
  76.  
  77.     /**
  78.      * Get a list of filter options for the templates with styles.
  79.      *
  80.      * @param   mixed  $clientId  The CMS client id (0:site | 1:administrator) or '*' for all.
  81.      *
  82.      * @return  array  An array of JHtmlOption elements.
  83.      */
  84.     public static function getTemplateOptions($clientId = '*')
  85.     {
  86.         // Build the filter options.
  87.         $db = JFactory::getDbo();
  88.         $query = $db->getQuery(true);
  89.  
  90.         if ($clientId != '*')
  91.         {
  92.             $query->where('client_id=' . (int) $clientId);
  93.         }
  94.  
  95.         $query->select('element as value, name as text, extension_id as e_id')
  96.             ->from('#__extensions')
  97.             ->where('type = ' . $db->quote('template'))
  98.             ->where('enabled = 1')
  99.             ->order('client_id')
  100.             ->order('name');
  101.         $db->setQuery($query);
  102.         $options = $db->loadObjectList();
  103.  
  104.         return $options;
  105.     }
  106.  
  107.     /**
  108.      * TODO
  109.      *
  110.      * @param   string  $templateBaseDir  TODO
  111.      * @param   string  $templateDir      TODO
  112.      *
  113.      * @return  boolean|JObject
  114.      */
  115.     public static function parseXMLTemplateFile($templateBaseDir, $templateDir)
  116.     {
  117.         $data = new JObject;
  118.  
  119.         // Check of the xml file exists
  120.         $filePath = JPath::clean($templateBaseDir . '/templates/' . $templateDir . '/templateDetails.xml');
  121.  
  122.         if (is_file($filePath))
  123.         {
  124.             $xml = JInstaller::parseXMLInstallFile($filePath);
  125.  
  126.             if ($xml['type'] != 'template')
  127.             {
  128.                 return false;
  129.             }
  130.  
  131.             foreach ($xml as $key => $value)
  132.             {
  133.                 $data->set($key, $value);
  134.             }
  135.         }
  136.  
  137.         return $data;
  138.     }
  139.  
  140.     /**
  141.      * TODO
  142.      *
  143.      * @param   integer  $clientId     TODO
  144.      * @param   string   $templateDir  TODO
  145.      *
  146.      * @return  boolean|array
  147.      *
  148.      * @since   3.0
  149.      */
  150.     public static function getPositions($clientId, $templateDir)
  151.     {
  152.         $positions = array();
  153.  
  154.         $templateBaseDir = $clientId ? JPATH_ADMINISTRATOR : JPATH_SITE;
  155.         $filePath = JPath::clean($templateBaseDir . '/templates/' . $templateDir . '/templateDetails.xml');
  156.  
  157.         if (is_file($filePath))
  158.         {
  159.             // Read the file to see if it's a valid component XML file
  160.             $xml = simplexml_load_file($filePath);
  161.  
  162.             if (!$xml)
  163.             {
  164.                 return false;
  165.             }
  166.  
  167.             // Check for a valid XML root tag.
  168.  
  169.             // Extensions use 'extension' as the root tag.  Languages use 'metafile' instead
  170.  
  171.             if ($xml->getName() != 'extension' && $xml->getName() != 'metafile')
  172.             {
  173.                 unset($xml);
  174.  
  175.                 return false;
  176.             }
  177.  
  178.             $positions = (array) $xml->positions;
  179.  
  180.             if (isset($positions['position']))
  181.             {
  182.                 $positions = $positions['position'];
  183.             }
  184.             else
  185.             {
  186.                 $positions = array();
  187.             }
  188.         }
  189.  
  190.         return $positions;
  191.     }
  192. }

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