ApplicationHelper
Application helper functions
since |
1.5 |
---|---|
package |
Joomla CMS |
Methods
addClientInfo
Adds information for a client.
addClientInfo( client) :
since |
1.6 |
---|
Arguments
- client
mixed
A client identifier either an array or object
Response
bool
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(int|string|null id = null, byName = false) : \stdClass|\stdClass[]|null
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
int|string|null
A client identifier- byName
bool
If true, find the client by its name
Response
stdClass|array<string|int, stdClass>|null
Object describing the client, array containing all the clients or null if $id not known
getComponentName
Return the name of the request component [main component]
getComponentName( default = null) :
since |
1.6 |
---|
Arguments
- default
string
The default option
Response
string
Option (e.g. com_something)
getHash
Provides a secure hash based on a seed
getHash( seed) :
since |
3.2 |
---|
Arguments
- seed
string
Seed string.
Response
string
A secure hash
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, language = '') :
since |
3.2 |
---|
Arguments
- string
string
String to process- language
string
Language to transliterate to if unicode slugs are disabled
Response
string
Processed string
Properties
_clients
Client information array
since |
1.6 |
---|
Type(s)
array<string|int, mixed>