API15:JHelp/createURL

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.

Description

Create an URL for a giving help file reference

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

Syntax

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

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 (!preg_match( '#\.html$#i', $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 (!preg_match( '#\.html$#i', $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 transcluded page call, red link never existed >

Examples

<CodeExamplesForm />