Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/application/helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3. * @version        $Id: application.php 5801 2006-11-18 16:28:10Z chrisdavenport $
  4. * @package        Joomla.Framework
  5. * @subpackage    Application
  6. * @copyright    Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
  7. * @license        GNU/GPL, see LICENSE.php
  8. *  Joomla! is free software. This version may have been modified pursuant
  9. *  to the GNU General Public License, and as distributed it includes or
  10. *  is derivative of works licensed under the GNU General Public License or
  11. *  other free or open source software licenses.
  12. *  See COPYRIGHT.php for copyright notices and details.
  13. */
  14.  
  15. // Check to ensure this file is within the rest of the framework
  16. defined('JPATH_BASE') or die();
  17.  
  18. /**
  19.  * Application helper functions
  20.  *
  21.  * @static
  22.  * @package        Joomla.Framework
  23.  * @subpackage    Application
  24.  * @since        1.5
  25.  */
  26. class JApplicationHelper
  27. {
  28.  
  29.     /**
  30.      * Gets information on a specific client id.  This method will be useful in
  31.      * future versions when we start mapping applications in the database.
  32.      *
  33.      * @access    public
  34.      * @param    int        $id    A client identifier
  35.      * @return    mixed    Object describing the client or false if not known
  36.      * @since    1.5
  37.      */
  38.     function getClientInfo($id = null, $byName = false)
  39.     {
  40.         global $mainframe;
  41.  
  42.         static $clients;
  43.  
  44.         if(!isset($id)) {
  45.             $id = $mainframe->getClientId();
  46.         }
  47.  
  48.         // Only create the array if it does not exist
  49.         if (!is_array($clients))
  50.         {
  51.             $obj = new stdClass();
  52.  
  53.             // Site Client
  54.             $obj->id        = 0;
  55.             $obj->name    = 'site';
  56.             $obj->path    = JPATH_SITE;
  57.             $clients[0] = clone($obj);
  58.  
  59.             // Administrator Client
  60.             $obj->id        = 1;
  61.             $obj->name    = 'administrator';
  62.             $obj->path    = JPATH_ADMINISTRATOR;
  63.             $clients[1] = clone($obj);
  64.  
  65.             // Installation Client
  66.             $obj->id        = 2;
  67.             $obj->name    = 'installation';
  68.             $obj->path    = JPATH_INSTALLATION;
  69.             $clients[2] = clone($obj);
  70.         }
  71.  
  72.         /*
  73.          * Are we looking for client information by id or by name?
  74.          */
  75.         if (!$byName)
  76.         {
  77.             if (!isset($clients[$id])){
  78.                 return false;
  79.             } else {
  80.                 return $clients[$id];
  81.             }
  82.         }
  83.         else
  84.         {
  85.             foreach ($clients as $client) {
  86.                 if ($client->name == strtolower($id)) {
  87.                     return $client;
  88.                 }
  89.             }
  90.             return false;
  91.         }
  92.     }
  93.  
  94.     /**
  95.     * Get a path
  96.     *
  97.     * @access public
  98.     * @param string $varname 
  99.     * @param string $user_option 
  100.     * @return string The requested path
  101.     * @since 1.0
  102.     */
  103.     function getPath( $varname, $user_option=null )
  104.     {
  105.         // check needed for handling of custom/new module xml file loading
  106.         $check = ( ( $varname == 'mod0_xml' ) || ( $varname == 'mod1_xml' ) );
  107.  
  108.         if ( !$user_option && !$check ) {
  109.             $user_option = JRequest::getVar('option', null);
  110.         }
  111.  
  112.         $result = null;
  113.         $name     = substr( $user_option, 4 );
  114.  
  115.         switch ($varname) {
  116.             case 'front':
  117.                 $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.php', 0 );
  118.                 break;
  119.  
  120.             case 'html':
  121.             case 'front_html':
  122.                 if ( !( $result = JApplicationHelper::_checkPath( DS.'templates'.DS. JApplication::getTemplate() .DS.'components'.DS. $name .'.html.php', 0 ) ) ) {
  123.                     $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.html.php', 0 );
  124.                 }
  125.                 break;
  126.  
  127.             case 'toolbar':
  128.                 $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS.'toolbar.'. $name .'.php', -1 );
  129.                 break;
  130.  
  131.             case 'toolbar_html':
  132.                 $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS.'toolbar.'. $name .'.html.php', -1 );
  133.                 break;
  134.  
  135.             case 'toolbar_default':
  136.             case 'toolbar_front':
  137.                 $result = JApplicationHelper::_checkPath( DS.'includes'.DS.'HTML_toolbar.php', 0 );
  138.                 break;
  139.  
  140.             case 'admin':
  141.                 $path     = DS.'components'.DS. $user_option .DS.'admin.'. $name .'.php';
  142.                 $result = JApplicationHelper::_checkPath( $path, -1 );
  143.                 break;
  144.  
  145.             case 'admin_html':
  146.                 $path    = DS.'components'.DS. $user_option .DS.'admin.'. $name .'.html.php';
  147.                 $result = JApplicationHelper::_checkPath( $path, -1 );
  148.                 break;
  149.  
  150.             case 'admin_functions':
  151.                 $path    = DS.'components'.DS. $user_option .DS. $name .'.functions.php';
  152.                 $result = JApplicationHelper::_checkPath( $path, -1 );
  153.                 break;
  154.  
  155.             case 'class':
  156.                 if ( !( $result = JApplicationHelper::_checkPath( DS.'components'.DS. $user_option .DS. $name .'.class.php' ) ) ) {
  157.                     $result = JApplicationHelper::_checkPath( DS.'includes'.DS. $name .'.php' );
  158.                 }
  159.                 break;
  160.  
  161.             case 'helper':
  162.                 $path    = DS.'components'.DS. $user_option .DS. $name .'.helper.php';
  163.                 $result = JApplicationHelper::_checkPath( $path );
  164.                 break;
  165.  
  166.             case 'com_xml':
  167.                 $path     = DS.'components'.DS. $user_option .DS. $name .'.xml';
  168.                 $result = JApplicationHelper::_checkPath( $path, 1 );
  169.                 break;
  170.  
  171.             case 'mod0_xml':
  172.                 $path = DS.'modules'.DS. $user_option .DS. $user_option. '.xml';
  173.                 $result = JApplicationHelper::_checkPath( $path );
  174.                 break;
  175.  
  176.             case 'mod1_xml':
  177.                 // admin modules
  178.                 $path = DS.'modules'.DS. $user_option .DS. $user_option. '.xml';
  179.                 $result = JApplicationHelper::_checkPath( $path, -1 );
  180.                 break;
  181.  
  182.             case 'bot_xml':
  183.                 // legacy value
  184.             case 'plg_xml':
  185.                 // Site plugins
  186.                 $path     = DS.'plugins'.DS. $user_option .'.xml';
  187.                 $result = JApplicationHelper::_checkPath( $path, 0 );
  188.                 break;
  189.  
  190.             case 'menu_xml':
  191.                 $path     = DS.'components'.DS.'com_menus'.DS. $user_option .DS. $user_option .'.xml';
  192.                 $result = JApplicationHelper::_checkPath( $path, -1 );
  193.                 break;
  194.         }
  195.  
  196.         return $result;
  197.     }
  198.  
  199.     function parseXMLInstallFile($path)
  200.     {
  201.         // Read the file to see if it's a valid component XML file
  202.         $xml = & JFactory::getXMLParser('Simple');
  203.  
  204.         if (!$xml->loadFile($path)) {
  205.             unset($xml);
  206.             return false;
  207.         }
  208.  
  209.         /*
  210.          * Check for a valid XML root tag.
  211.          *
  212.          * Should be 'install', but for backward compatability we will accept 'mosinstall'.
  213.          */
  214.         if ($xml->document->name() != 'install' && $xml->document->name() != 'mosinstall') {
  215.             unset($xml);
  216.             return false;
  217.         }
  218.  
  219.         $data = array();
  220.  
  221.         $element = & $xml->document->name[0];
  222.         $data['name'] = $element ? $element->data() : '';
  223.         $data['type'] = $element ? $xml->document->attributes("type") : '';
  224.  
  225.         $element = & $xml->document->creationdate[0];
  226.         $data['creationdate'] = $element ? $element->data() : 'Unknown';
  227.  
  228.         $element = & $xml->document->author[0];
  229.         $data['author'] = $element ? $element->data() : 'Unknown';
  230.  
  231.         $element = & $xml->document->copyright[0];
  232.         $data['copyright'] = $element ? $element->data() : '';
  233.  
  234.         $element = & $xml->document->authoremail[0];
  235.         $data['authorEmail'] = $element ? $element->data() : '';
  236.  
  237.         $element = & $xml->document->authorurl[0];
  238.         $data['authorUrl'] = $element ? $element->data() : '';
  239.  
  240.         $element = & $xml->document->version[0];
  241.         $data['version'] = $element ? $element->data() : '';
  242.  
  243.         $element = & $xml->document->description[0];
  244.         $data['description'] = $element ? $element->data() : '';
  245.  
  246.         $element = & $xml->document->group[0];
  247.         $data['group'] = $element ? $element->data() : '';
  248.  
  249.         return $data;
  250.     }
  251.  
  252.     function parseXMLLangMetaFile($path)
  253.     {
  254.         // Read the file to see if it's a valid component XML file
  255.         $xml = & JFactory::getXMLParser('Simple');
  256.  
  257.         if (!$xml->loadFile($path)) {
  258.             unset($xml);
  259.             return false;
  260.         }
  261.  
  262.         /*
  263.          * Check for a valid XML root tag.
  264.          *
  265.          * Should be 'langMetaData'.
  266.          */
  267.         if ($xml->document->name() != 'metafile') {
  268.             unset($xml);
  269.             return false;
  270.         }
  271.  
  272.         $data = array();
  273.  
  274.         $element = & $xml->document->name[0];
  275.         $data['name'] = $element ? $element->data() : '';
  276.         $data['type'] = $element ? $xml->document->attributes("type") : '';
  277.  
  278.         $element = & $xml->document->creationdate[0];
  279.         $data['creationdate'] = $element ? $element->data() : 'Unknown';
  280.  
  281.         $element = & $xml->document->author[0];
  282.         $data['author'] = $element ? $element->data() : 'Unknown';
  283.  
  284.         $element = & $xml->document->copyright[0];
  285.         $data['copyright'] = $element ? $element->data() : '';
  286.  
  287.         $element = & $xml->document->authoremail[0];
  288.         $data['authorEmail'] = $element ? $element->data() : '';
  289.  
  290.         $element = & $xml->document->authorurl[0];
  291.         $data['authorUrl'] = $element ? $element->data() : '';
  292.  
  293.         $element = & $xml->document->version[0];
  294.         $data['version'] = $element ? $element->data() : '';
  295.  
  296.         $element = & $xml->document->description[0];
  297.         $data['description'] = $element ? $element->data() : '';
  298.  
  299.         $element = & $xml->document->group[0];
  300.         $data['group'] = $element ? $element->group() : '';
  301.         return $data;
  302.     }
  303.  
  304.     /**
  305.      * Tries to find a file in the administrator or site areas
  306.      *
  307.      * @access private
  308.      * @param string     $parth            A file name
  309.      * @param integer     $checkAdmin        0 to check site only, 1 to check site and admin, -1 to check admin only
  310.      * @since 1.5
  311.      */
  312.     function _checkPath( $path, $checkAdmin=1 )
  313.     {
  314.         $file = JPATH_SITE . $path;
  315.         if ($checkAdmin > -1 && file_exists( $file )) {
  316.             return $file;
  317.         } else if ($checkAdmin != 0) {
  318.             $file = JPATH_ADMINISTRATOR . $path;
  319.             if (file_exists( $file )) {
  320.                 return $file;
  321.             }
  322.         }
  323.  
  324.         return null;
  325.     }
  326.  
  327. }
  328. ?>
Documentation generated on Mon, 05 Mar 2007 21:05:57 +0000 by phpDocumentor 1.3.1