Référence de la classe ApplicationHelper

Fonctions membres publiques statiques
static	getComponentName ($default=null)
static	getHash ($seed)
static	stringURLSafe ($string, $language='')
static	getClientInfo ($id=null, $byName=false)
static	addClientInfo ($client)
static	parseXMLInstallFile ($path)
static	parseXMLLangMetaFile ($path)

Attributs protégés statiques
static	$_clients = array()

Description détaillée

Application helper functions

Depuis

1.5

Documentation des fonctions membres

addClientInfo()

static addClientInfo (   $client )

static

Adds information for a client.

Paramètres

mixed

$client

A client identifier either an array or object

Renvoie

boolean True if the information is added. False on error

Depuis

1.6

Références $client, et $info.

getClientInfo()

static getClientInfo (   $id = null,   $byName = false  )

static

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.

Paramètres

integer	$id	A client identifier
boolean	$byName	If True, find the client by its name

Renvoie

mixed Object describing the client or false if not known

Depuis

1.5

Références $client, $id, JPATH_ADMINISTRATOR, JPATH_INSTALLATION, JPATH_SITE, et null.

Référencé par InstallerExtension\__construct(), PackageAdapter\_getExtensionId(), CollectionAdapter\_startElement(), Installer\copyManifest(), ModuleAdapter\discover(), TemplateAdapter\discover(), LanguageAdapter\discover_install(), ExtensionAdapter\findUpdate(), TemplatestyleField\getGroups(), Pathway\getInstance(), Router\getInstance(), LanguageAdapter\install(), Installer\parseFiles(), Installer\parseLanguages(), ModuleAdapter\prepareDiscoverInstall(), TemplateAdapter\prepareDiscoverInstall(), PluginAdapter\prepareDiscoverInstall(), ModuleAdapter\refreshManifestCache(), TemplateAdapter\refreshManifestCache(), PluginAdapter\refreshManifestCache(), LanguageAdapter\refreshManifestCache(), ComponentAdapter\refreshManifestCache(), Installer\removeFiles(), ModulepositionField\setup(), ModuleAdapter\setupInstallPaths(), TemplateAdapter\setupInstallPaths(), TemplateAdapter\uninstall(), PackageAdapter\uninstall(), LanguageAdapter\uninstall(), et LanguageAdapter\update().

getComponentName()

static getComponentName (   $default = null )

static

Return the name of the request component [main component]

Paramètres

string

$default

The default option

Renvoie

string Option (e.g. com_something)

Depuis

1.6

Références $default, $input, et $option.

Référencé par FileLayout\setComponent().

getHash()

static getHash (   $seed )

static

Provides a secure hash based on a seed

Paramètres

string

$seed

Seed string.

Renvoie

string A secure hash

Depuis

3.2

Référencé par CMSHelper\getCurrentLanguage(), ContentHelper\getCurrentLanguage(), et Session\getFormToken().

parseXMLInstallFile()

static parseXMLInstallFile (   $path )

static

Parse a XML install manifest file.

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

Paramètres

string

$path

Full path to XML file.

Renvoie

array XML metadata.

Depuis

1.5

Obsolète:

4.0 Use ::parseXMLInstallFile instead.

Références $path.

parseXMLLangMetaFile()

static parseXMLLangMetaFile (   $path )

static

Parse a XML language meta file.

XML Root tag for languages which is meta file.

Paramètres

string

$path

Full path to XML file.

Renvoie

array XML metadata.

Depuis

1.5

Obsolète:

4.0 Use ::parseXMLInstallFile instead.

Références $data, et $path.

stringURLSafe()

static stringURLSafe (   $string,   $language = ''  )

static

This method transliterates a string into a URL safe string or returns a URL safe UTF-8 string based on the global configuration

Paramètres

string	$string	String to process
string	$language	Language to transliterate to if unicode slugs are disabled

Renvoie

string Processed string

Depuis

3.2

Références $language, $output, et ComponentHelper\getParams().

Référencé par MenuType\check(), Category\check(), Content\check(), et Menu\store().

Documentation des champs

$_clients

$_clients = array()

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• ApplicationHelper.php