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
static deprecated
since

11.1

deprecated

12.1

Arguments

$path

stringA file name

$checkAdmin

integer0 to check site only, 1 to check site and admin, -1 to check admin only

Response

stringFile name or null

addClientInfo

Adds information for a client.

addClientInfo(mixed $client) : boolean
static
since

11.1

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
static

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

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
static
since

11.1

Arguments

$default

stringThe default option

Response

stringOption (e.g. com_something)

getPath

Get a path

getPath(string $varname, string $user_option = null) : string
static deprecated
since

11.1

deprecated

12.1

Arguments

$varname

stringIdentify location or type of xml

$user_option

stringOption (e.g. com_something) used to find path.

Response

stringThe requested path

parseXMLInstallFile

Parse a XML install manifest file.

parseXMLInstallFile(string $path) : array
static deprecated

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

stringFull path to XML file.

Response

arrayXML metadata.

parseXMLLangMetaFile

Parse a XML language meta file.

parseXMLLangMetaFile(string $path) : array
static

XML Root tag for languages which is meta file.

Arguments

$path

stringFull path to XML file.

Response

arrayXML metadata.

Properties

_clients

Client information array

static
since

11.1

Type(s)

array