Files
@ c7d7e38b2269
Branch filter:
Location: hot67beta/libraries/joomla/language/help.php
c7d7e38b2269
3.6 KiB
text/x-php
Initial import of the site.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | <?php
/**
* @version $Id: help.php 10381 2008-06-01 03:35:53Z pasamio $
* @package Joomla.Framework
* @subpackage Language
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
* Joomla! is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/
/**
* Help system class
*
* @package Joomla.Framework
* @subpackage Language
* @since 1.5
*/
class JHelp
{
/**
* Create an URL for a giving help file reference
*
* @param string The name of the popup file (excluding the file extension for an xml file)
* @param boolean Use the help file in the component directory
*/
function createURL($ref, $useComponent = false)
{
global $mainframe, $option;
$user =& JFactory::getUser();
$userHelpUrl = $user->getParam( 'helpsite' );
$globalHelpUrl = $mainframe->getCfg('helpurl');
$lang =& JFactory::getLanguage();
if ($useComponent)
{
if (!eregi( '\.html$', $ref )) {
$ref = $ref . '.html';
}
$url = 'components/' . $option. '/help';
$tag = $lang->getTag();
// Check if the file exists within a different language!
if( $lang->getTag() != 'en-GB' ) {
$localeURL = JPATH_BASE.DS.$url.DS.$tag.DS.$ref;
jimport( 'joomla.filesystem.file' );
if( !JFile::exists( $localeURL ) ) {
$tag = 'en-GB';
}
}
return $url.'/'.$tag.'/'.$ref;
}
if ( $userHelpUrl )
{
// Online help site as defined in GC
$version = new JVersion();
$ref .= $version->getHelpVersion();
$url = $userHelpUrl . '/index2.php?option=com_content&task=findkey&tmpl=component&keyref=' . urlencode( $ref );
}
else if ( $globalHelpUrl )
{
// Online help site as defined in GC
$version = new JVersion();
$ref .= $version->getHelpVersion();
$url = $globalHelpUrl . '/index2.php?option=com_content&task=findkey&tmpl=component;1&keyref=' . urlencode( $ref );
}
else
{
// Included html help files
$helpURL = 'help/' .$lang->getTag() .'/';
if (!eregi( '\.html$', $ref )) {
$ref = $ref . '.html';
}
// Check if the file exists within a different language!
if( $lang->getTag() != 'en-GB' ) {
$localeURL = JPATH_BASE . $helpURL .$ref;
jimport( 'joomla.filesystem.file' );
if( !JFile::exists( $localeURL ) ) {
$helpURL = 'help/en-GB/';
}
}
$url = $helpURL . $ref;
}
return $url;
}
/**
* Builds a list of the help sites which can be used in a select option
*
* @param string Path to an xml file
* @param string Language tag to select (if exists)
* @param array An array of arrays ( text, value, selected )
*/
function createSiteList($pathToXml, $selected = null)
{
$list = array ();
$xml =& JFactory::getXMLParser('Simple');
$data = null;
if( !empty( $pathToXml ) ) {
$data = file_get_contents($pathToXml);
}
if(empty($data))
{
$option['text'] = 'English (GB) help.joomla.org';
$option['value'] = 'http://help.joomla.org';
$list[] = $option;
}
else
{
if($xml->loadString($data))
{
// Are there any languages??
$elmSites = & $xml->document->sites[0];
if (is_object($elmSites)) {
$option = array ();
$sites = $elmSites->children();
foreach ($sites as $site)
{
$text = $site->data();
$url = $site->attributes('url');
$option['text'] = $text;
$option['value'] = $url;
$list[] = $option;
}
}
}
}
return $list;
}
}
|