Docs For Class JApplicationHelper

Description

Application helper functions

since: 1.5

Located in /libraries/cms/application/helper.php (line 19)

Variable Summary

static array $_clients

Method Summary

static boolean addClientInfo (mixed $client)

static mixed getClientInfo ([integer $id = null], [boolean $byName = false])

static string getComponentName ([string $default = null])

static string getHash (string $seed)

static array parseXMLInstallFile (string $path)

static array parseXMLLangMetaFile (string $path)

static string stringURLSafe (string $string)

Variables

static array $_clients = null (line 27)

Client information array

since: 1.6
access: protected

Methods

static addClientInfo (line 175)

Adds information for a client.

return: True if the information is added. False on error
since: 1.6
access: public

static boolean addClientInfo (mixed $client)

mixed $client: A client identifier either an array or object

static getClientInfo (line 112)

Gets information on a specific client id. This method will be useful in future versions when we start mapping applications in the database.

This method will return a client information array if called with no arguments which can be used to add custom application information.

return: Object describing the client or false if not known
since: 1.5
access: public

static mixed getClientInfo ([integer $id = null], [boolean $byName = false])

integer $id: A client identifier
boolean $byName: If True, find the client by its name

static getComponentName (line 38)

Return the name of the request component [main component]

return: Option (e.g. com_something)
since: 1.6
access: public

static string getComponentName ([string $default = null])

string $default: The default option

static getHash (line 68)

Provides a secure hash based on a seed

return: A secure hash
since: 3.2
access: public

static string getHash (string $seed)

string $seed: Seed string.

static parseXMLInstallFile (line 211)

Parse a XML install manifest file.

XML Root tag should be 'install' except for languages which use meta file.

return: XML metadata.
deprecated: 4.0 Use JInstaller::parseXMLInstallFile instead.
since: 1.5
access: public

static array parseXMLInstallFile (string $path)

string $path: Full path to XML file.

static parseXMLLangMetaFile (line 229)

Parse a XML language meta file.

XML Root tag for languages which is meta file.

return: XML metadata.
deprecated: 4.0 Use JInstaller::parseXMLInstallFile instead.
since: 1.5
access: public

static array parseXMLLangMetaFile (string $path)

string $path: Full path to XML file.

static stringURLSafe (line 84)

This method transliterates a string into an URL safe string or returns a URL safe UTF-8 string based on the global configuration

return: Processed string
since: 3.2
access: public

static string stringURLSafe (string $string)

string $string: String to process