Class JApplicationHelper

Description

Application helper functions

  • since: 11.1

Located in /libraries/joomla/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 getPath (string $varname, [string $user_option = null])
static array parseXMLInstallFile (string $path)
static array parseXMLLangMetaFile (string $path)
static string _checkPath (string $path, [integer $checkAdmin = 1])
Variables
static array $_clients = null (line 27)

Client information array

  • since: 11.1
  • access: protected
Methods
static method addClientInfo (line 135)

Adds information for a client.

  • return: True if the information is added. False on error
  • since: 11.1
  • access: public
static boolean addClientInfo (mixed $client)
  • mixed $client: A client identifier either an array or object
static method getClientInfo (line 72)

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: 11.1
  • 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 method getComponentName (line 38)

Return the name of the request component [main component]

  • return: Option (e.g. com_something)
  • since: 11.1
  • access: public
static string getComponentName ([string $default = null])
  • string $default: The default option
static method getPath (line 170)

Get a path

  • return: The requested path
  • deprecated: 12.1
  • since: 11.1
  • access: public
static string getPath (string $varname, [string $user_option = null])
  • string $varname: Identify location or type of xml
  • string $user_option: Option (e.g. com_something) used to find path.
static method parseXMLInstallFile (line 295)

Parse a XML install manifest file.

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

  • return: XML metadata.
  • deprecated: 13.3 Use JInstaller::parseXMLInstallFile instead.
  • since: 11.1
  • access: public
static array parseXMLInstallFile (string $path)
  • string $path: Full path to XML file.
static method parseXMLLangMetaFile (line 347)

Parse a XML language meta file.

XML Root tag for languages which is meta file.

  • return: XML metadata.
  • access: public
static array parseXMLLangMetaFile (string $path)
  • string $path: Full path to XML file.
static method _checkPath (line 397)

Tries to find a file in the administrator or site areas

  • return: File name or null
  • deprecated: 12.1
  • since: 11.1
  • access: protected
static string _checkPath (string $path, [integer $checkAdmin = 1])
  • string $path: A file name
  • integer $checkAdmin:
    1. to check site only, 1 to check site and admin, -1 to check admin only

Documentation generated on Mon, 25 Jun 2012 13:55:27 -0500 by phpDocumentor 1.4.4