Actions

API16

JHelp/createURL

From Joomla! Documentation

< API16:JHelp
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Create an URL for a giving help file reference

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

static createURL($ref, $useComponent=false)
Parameter Name Default Value Description
$ref The name of the popup file (excluding the file extension for an xml file)
$useComponent false Use the help file in the component directory

Defined in

libraries/joomla/language/help.php

Importing

jimport( 'joomla.language.help' );

Source Body

static function createURL($ref, $useComponent = false)
{
        $component              = JApplicationHelper::getComponentName();
        $app                    = &JFactory::getApplication();
        $user                   = &JFactory::getUser();
        $userHelpUrl    = $user->getParam('helpsite');
        $globalHelpUrl  = $app->getCfg('helpurl');
        $lang                   = &JFactory::getLanguage();
 
        if ($useComponent) {
                if (!preg_match('#\.html$#i', $ref)) {
                        $ref = $ref . '.html';
                }
 
                $url = 'components/' . $component. '/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&amp;task=findkey&amp;tmpl=component&amp;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&amp;task=findkey&amp;tmpl=component;1&amp;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;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />