Référence de la classe JApplicationHelper

Liste de tous les membres

Fonctions membres publiques statiques
static	getComponentName ($default=null)
static	getClientInfo ($id=null, $byName=false)
static	addClientInfo ($client)
static	getPath ($varname, $user_option=null)
static	parseXMLInstallFile ($path)
static	parseXMLLangMetaFile ($path)

Fonctions membres protégées statiques
static	_checkPath ($path, $checkAdmin=1)

Attributs protégés statiques
static	$_clients = null

---

Documentation des fonctions membres

static JApplicationHelper::_checkPath (   $path,   $checkAdmin = 1  )

staticprotected

Tries to find a file in the administrator or site areas

Paramètres:

string	$path	A file name
integer	$checkAdmin	0 to check site only, 1 to check site and admin, -1 to check admin only

Renvoie:

string File name or null

Depuis:

11.1

Obsolète:

12.1

Références $file, $path, elseif, JPATH_ADMINISTRATOR, JPATH_SITE, et null.

static JApplicationHelper::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:

11.1

Références $client.

static JApplicationHelper::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:

11.1

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

Référencé par JExtension\__construct(), JInstallerPackage\_getExtensionID(), JUpdaterCollection\_startElement(), TemplatesModelTemplate\copy(), JInstaller\copyManifest(), JInstallerTemplate\discover(), JInstallerModule\discover(), JInstallerTemplate\discover_install(), JInstallerModule\discover_install(), JInstallerLanguage\discover_install(), JInstallerPlugin\discover_install(), JInstallerComponent\discover_install(), TemplatesViewPrevuuw\display(), JUpdaterExtension\findUpdate(), LanguagesModelInstalled\getClient(), TemplatesModelTemplate\getFiles(), JFormFieldTemplateStyle\getGroups(), JFormFieldModulePosition\getInput(), JFormFieldModuleLayout\getInput(), JFormFieldComponentLayout\getInput(), JPathway\getInstance(), JMenu\getInstance(), JRouter\getInstance(), JApplication\getInstance(), TemplatesModelStyle\getItem(), ModulesModelModule\getItem(), TemplatesModelTemplates\getItems(), ModulesModelPositions\getItems(), ModulesModelSelect\getItems(), TemplatesModelSource\getSource(), JAdministrator\initialise(), JSite\initialise(), JInstallerLanguage\install(), JInstallerTemplate\install(), JInstallerModule\install(), JInstaller\parseFiles(), JInstaller\parseLanguages(), JInstaller\parseMedia(), CacheModelCache\populateState(), PluginsModelPlugin\preprocessForm(), TemplatesModelStyle\preprocessForm(), ModulesModelModule\preprocessForm(), JInstallerTemplate\refreshManifestCache(), JInstallerLanguage\refreshManifestCache(), JInstallerModule\refreshManifestCache(), JInstallerPlugin\refreshManifestCache(), JInstallerComponent\refreshManifestCache(), JInstaller\removeFiles(), TemplatesModelSource\save(), JHtmlTemplates\thumb(), JInstallerTemplate\uninstall(), JInstallerPackage\uninstall(), JInstallerLanguage\uninstall(), JInstallerModule\uninstall(), et JInstallerLanguage\update().

static JApplicationHelper::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:

11.1

Références JRequest\getCmd(), et JRequest\setVar().

Référencé par JView\_setPath(), et JHelp\createURL().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JApplicationHelper::getPath (   $varname,   $user_option = null  )

static

Get a path

Paramètres:

string	$varname	Identify location or type of xml
string	$user_option	Option (e.g. com_something) used to find path.

Renvoie:

string The requested path

Depuis:

11.1

Obsolète:

12.1

Références $check, $name, $parts, $path, DIRECTORY_SEPARATOR, JRequest\getCmd(), JFilterInput\getInstance(), JApplication\getTemplate(), et null.

Référencé par JComponentHelper\renderComponent().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JApplicationHelper::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:

11.1

Obsolète:

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.

Références $data, $path, JText\_(), JLog\add(), JFactory\getXML(), et JLog\WARNING.

Référencé par JInstallerLibrary\discover(), JInstallerTemplate\discover(), JInstallerLanguage\discover(), JInstallerModule\discover(), JInstallerPlugin\discover(), JInstallerComponent\discover(), JInstallerLibrary\discover_install(), JInstallerTemplate\discover_install(), JInstallerModule\discover_install(), JInstallerLanguage\discover_install(), JInstallerPlugin\discover_install(), JInstallerComponent\discover_install(), JInstaller\generateManifestCache(), JInstallerLibrary\refreshManifestCache(), JInstallerPackage\refreshManifestCache(), JInstallerTemplate\refreshManifestCache(), JInstallerLanguage\refreshManifestCache(), JInstallerModule\refreshManifestCache(), JInstallerFile\refreshManifestCache(), JInstallerPlugin\refreshManifestCache(), et JInstallerComponent\refreshManifestCache().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JApplicationHelper::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.

Références $data, $path, JText\_(), et JFactory\getXML().

Référencé par LanguagesModelInstalled\getData().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

---

Documentation des données membres

JApplicationHelper::$_clients = null

staticprotected

---

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

• libraries/joomla/application/helper.php