API17:JApplicationHelper
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JApplicationHelper== | ||
| + | ===Description=== | ||
| + | {{Description:JApplicationHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JApplicationHelper|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JApplicationHelper|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public static | ||
|[[JApplicationHelper::addClientInfo/11.1|addClientInfo]] | |[[JApplicationHelper::addClientInfo/11.1|addClientInfo]] | ||
|Adds information for a client. | |Adds information for a client. | ||
|- | |- | ||
| + | |public static | ||
|[[JApplicationHelper::getClientInfo/11.1|getClientInfo]] | |[[JApplicationHelper::getClientInfo/11.1|getClientInfo]] | ||
|Gets information on a specific client id. | |Gets information on a specific client id. | ||
|- | |- | ||
| + | |public static | ||
|[[JApplicationHelper::getComponentName/11.1|getComponentName]] | |[[JApplicationHelper::getComponentName/11.1|getComponentName]] | ||
|Return the name of the request component [main component]. | |Return the name of the request component [main component]. | ||
|- | |- | ||
| + | |public static | ||
|[[JApplicationHelper::getPath/11.1|getPath]] | |[[JApplicationHelper::getPath/11.1|getPath]] | ||
|Get a path. | |Get a path. | ||
|- | |- | ||
| + | |public static | ||
|[[JApplicationHelper::parseXMLInstallFile/11.1|parseXMLInstallFile]] | |[[JApplicationHelper::parseXMLInstallFile/11.1|parseXMLInstallFile]] | ||
|Parse a XML install manifest file. | |Parse a XML install manifest file. | ||
|- | |- | ||
| + | |public static | ||
|[[JApplicationHelper::parseXMLLangMetaFile/11.1|parseXMLLangMetaFile]] | |[[JApplicationHelper::parseXMLLangMetaFile/11.1|parseXMLLangMetaFile]] | ||
| | | | ||
|- | |- | ||
| + | |protected static | ||
|[[JApplicationHelper::_checkPath/11.1|_checkPath]] | |[[JApplicationHelper::_checkPath/11.1|_checkPath]] | ||
|Tries to find a file in the administrator or site areas. | |Tries to find a file in the administrator or site areas. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/application/helper.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.helper' );</source> | <source lang="php">jimport( 'joomla.application.helper' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JApplicationHelper source code | + | * {{JVer|11.1}} '''JApplicationHelper source code''' on [[jplatform:application/helper.php|BitBucket]] |
| − | * [[JApplicationHelper|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]] |
| + | * [[JApplicationHelper|Other versions of JApplicationHelper]] | ||
{{SeeAlso:JApplicationHelper}} | {{SeeAlso:JApplicationHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JApplicationHelper|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JApplicationHelper|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 56: | Line 61: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JApplicationHelper]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JApplicationHelper]]</noinclude> | ||
Revision as of 17:55, 27 April 2011
JApplicationHelper
Description
JApplicationHelper is a class which provides helper functions for using JApplication. JApplicationHelper has functions to help you get client information, paths, and parse XML files into associative arrays. [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public static | addClientInfo | Adds information for a client. |
| public static | getClientInfo | Gets information on a specific client id. |
| public static | getComponentName | Return the name of the request component [main component]. |
| public static | getPath | Get a path. |
| public static | parseXMLInstallFile | Parse a XML install manifest file. |
| public static | parseXMLLangMetaFile | |
| protected static | _checkPath | Tries to find a file in the administrator or site areas. |
- Defined in libraries/joomla/application/helper.php
Importing
jimport( 'joomla.application.helper' );
See also
- JApplicationHelper source code on BitBucket
- Subpackage Application
- Other versions of JApplicationHelper
SeeAlso:JApplicationHelper [Edit See Also]
User contributed notes
<CodeExamplesForm />
