Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Help - list of methods

Help system class
Package: Joomla\CMS\Help
Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Help/Help.php
Project: Joomla

Method Summary

public static string
(mixed $ref, mixed $useComponent = false, mixed $override = null, mixed $component = null)

Create a URL for a given help key reference
Parameters
  • string $ref The name of the help screen (its key reference)
  • bool $useComponent Use the help file in the component directory
  • string $override Use this URL instead of any other
  • string $component Name of component (or null for current component)
Returns
  • string
Since
  • 1.5
Show source code of this method: createUrl Source Code

public static array
(mixed $pathToXml)

Builds a list of the help sites which can be used in a select option.
Parameters
  • string $pathToXml Path to an XML file.
Returns
  • array An array of arrays (text, value, selected).
Since
  • 1.5
Show source code of this method: createSiteList Source Code

Tags Summary

Since
1.5