/**
* @version $Id: help.php 9764 2007-12-30 07:48:11Z ircmaxell $
* @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;
}
}
