ApplicationHelper
Application helper functions
| since |
1.5 |
|---|
Methods
addClientInfo
Adds information for a client.
addClientInfo(mixed $client) : boolean
| since |
1.6 |
|---|
Arguments
$client
mixedA client identifier either an array or object
Response
booleanTrue 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 |
1.5 |
|---|
Arguments
$id
integerA client identifier
$byName
booleanIf True, find the client by its name
Response
mixedObject describing the client or false if not known
getComponentName
Return the name of the request component [main component]
getComponentName(string $default = null) : string
| since |
1.6 |
|---|
Arguments
$default
stringThe default option
Response
stringOption (e.g. com_something)
getHash
Provides a secure hash based on a seed
getHash(string $seed) : string
| since |
3.2 |
|---|
Arguments
$seed
stringSeed string.
Response
stringA secure hash
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 |
1.5 |
|---|---|
| deprecated |
4.0 Use \JInstaller::parseXMLInstallFile instead. |
Arguments
$path
stringFull path to XML file.
Response
arrayXML metadata.
parseXMLLangMetaFile
Parse a XML language meta file.
parseXMLLangMetaFile(string $path) : array
XML Root tag for languages which is meta file.
| since |
1.5 |
|---|---|
| deprecated |
4.0 Use \JInstaller::parseXMLInstallFile instead. |
Arguments
$path
stringFull path to XML file.
Response
arrayXML metadata.
stringURLSafe
This method transliterates a string into a URL safe string or returns a URL safe UTF-8 string based on the global configuration
stringURLSafe(string $string, string $language = '') : string
| since |
3.2 |
|---|
Arguments
$string
stringString to process
$language
stringLanguage to transliterate to if unicode slugs are disabled
Response
stringProcessed string
Properties
_clients
Client information array
Type(s)
array