API17:JClientHelper
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JClientHelper== | ||
| + | ===Description=== | ||
| + | {{Description:JClientHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JClientHelper|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JClientHelper|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public static | ||
|[[JClientHelper::getCredentials/11.1|getCredentials]] | |[[JClientHelper::getCredentials/11.1|getCredentials]] | ||
|Method to return the array of client layer configuration options. | |Method to return the array of client layer configuration options. | ||
|- | |- | ||
| + | |public static | ||
|[[JClientHelper::hasCredentials/11.1|hasCredentials]] | |[[JClientHelper::hasCredentials/11.1|hasCredentials]] | ||
|Method to determine if client login credentials are present. | |Method to determine if client login credentials are present. | ||
|- | |- | ||
| + | |public static | ||
|[[JClientHelper::setCredentials/11.1|setCredentials]] | |[[JClientHelper::setCredentials/11.1|setCredentials]] | ||
|Method to set client login credentials. | |Method to set client login credentials. | ||
|- | |- | ||
| + | |public static | ||
|[[JClientHelper::setCredentialsFromRequest/11.1|setCredentialsFromRequest]] | |[[JClientHelper::setCredentialsFromRequest/11.1|setCredentialsFromRequest]] | ||
|Determine wether input fields for client settings need to be shown. | |Determine wether input fields for client settings need to be shown. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/client/helper.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.client.helper' );</source> | <source lang="php">jimport( 'joomla.client.helper' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JClientHelper source code | + | * {{JVer|11.1}} '''JClientHelper source code''' on [[jplatform:client/helper.php|BitBucket]] |
| − | * [[JClientHelper|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Client/11.1|Client]] |
| + | * [[JClientHelper|Other versions of JClientHelper]] | ||
{{SeeAlso:JClientHelper}} | {{SeeAlso:JClientHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JClientHelper|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JClientHelper|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 47: | Line 49: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JClientHelper]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JClientHelper]]</noinclude> | ||
Revision as of 17:57, 27 April 2011
JClientHelper
Description
JClientHelper is a helper class to get, set and check for client credentials. [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public static | getCredentials | Method to return the array of client layer configuration options. |
| public static | hasCredentials | Method to determine if client login credentials are present. |
| public static | setCredentials | Method to set client login credentials. |
| public static | setCredentialsFromRequest | Determine wether input fields for client settings need to be shown. |
- Defined in libraries/joomla/client/helper.php
Importing
jimport( 'joomla.client.helper' );
See also
- JClientHelper source code on BitBucket
- Subpackage Client
- Other versions of JClientHelper
SeeAlso:JClientHelper [Edit See Also]
User contributed notes
<CodeExamplesForm />
