JApplicationHelper
Application helper functions
package |
Joomla.Platform |
---|---|
subpackage |
Application |
since |
11.1 |
Methods
_checkPath
Tries to find a file in the administrator or site areas
_checkPath(string $path, integer $checkAdmin = 1) : string
since |
11.1 |
---|---|
deprecated |
12.1 |
Arguments
- $path
string
A file name- $checkAdmin
integer
0 to check site only, 1 to check site and admin, -1 to check admin only
Response
string
File name or null
addClientInfo
Adds information for a client.
addClientInfo(mixed $client) : boolean
since |
11.1 |
---|
Arguments
- $client
mixed
A client identifier either an array or object
Response
boolean
True if the information is added. False on error
getClientInfo
Gets information on a specific client id. This method will be useful in future versions when we start mapping applications in the database.
getClientInfo(integer $id = null, boolean $byName = false) : mixed
This method will return a client information array if called with no arguments which can be used to add custom application information.
since |
11.1 |
---|
Arguments
- $id
integer
A client identifier- $byName
boolean
If True, find the client by its name
Response
mixed
Object describing the client or false if not known
getComponentName
Return the name of the request component [main component]
getComponentName(string $default = null) : string
since |
11.1 |
---|
Arguments
- $default
string
The default option
Response
string
Option (e.g. com_something)
getPath
Get a path
getPath(string $varname, string $user_option = null) : string
since |
11.1 |
---|---|
deprecated |
12.1 |
Arguments
- $varname
string
Identify location or type of xml- $user_option
string
Option (e.g. com_something) used to find path.
Response
string
The requested path
parseXMLInstallFile
Parse a XML install manifest file.
parseXMLInstallFile(string $path) : array
XML Root tag should be 'install' except for languages which use meta file.
since |
11.1 |
---|---|
deprecated |
13.3 Use JInstaller::parseXMLInstallFile instead. |
note |
This method must remain as is to allow updates from 2.5.4 and earlier sites to work. |
Arguments
- $path
string
Full path to XML file.
Response
array
XML metadata.
parseXMLLangMetaFile
Parse a XML language meta file.
parseXMLLangMetaFile(string $path) : array
XML Root tag for languages which is meta file.
Arguments
- $path
string
Full path to XML file.
Response
array
XML metadata.
Properties
_clients
Client information array
since |
11.1 |
---|
Type(s)
array