|
|
| Line 1: |
Line 1: |
| − | '''JClientHelper''' is a helper class to get, set and check for client credentials.
| + | This class is available in the following Joomla versions:- |
| − | | + | <splist showpath=notparent /> |
| − | ===Availability===
| + | <noinclude>[[Category:Framework]][[Category:JClientHelper]]</noinclude> |
| − | {{JVer|1.5}} {{JVer|1.6}}
| + | |
| − | | + | |
| − | ===Defined in===
| + | |
| − | /joomla/client/helper.php
| + | |
| − | | + | |
| − | ===Methods===
| + | |
| − | {| class="wikitable"
| + | |
| − | |-
| + | |
| − | !Method name
| + | |
| − | !Description
| + | |
| − | |-
| + | |
| − | |[[JClientHelper/getCredentials|getCredentials]]
| + | |
| − | |Returns Client layer configuration options, consisting of at least these fields: enabled, host, port, user, pass, root
| + | |
| − | |-
| + | |
| − | |[[JClientHelper/hasCredentials|hasCredentials]]
| + | |
| − | |Method to determine if client login credentials are present
| + | |
| − | |-
| + | |
| − | |[[JClientHelper/setCredentials|setCredentials]]
| + | |
| − | |Method to set client login credentials. Returns True if the given login credentials have been set and are valid.
| + | |
| − | |-
| + | |
| − | |[[JClientHelper/setCredentialsFromRequest|setCredentialsFromRequest]]
| + | |
| − | |If valid credentials were passed along with the request, they are saved to the session. This functions returns an exeption if invalid credentials have been given or if the connection to the server failed for some other reason.
| + | |
| − | |}
| + | |
| − | ===Importing===
| + | |
| − | <source lang="php">jimport( 'joomla.client.helper' );</source> | + | |
| − | | + | |
| − | ===See also===
| + | |
| − | * [http://api.joomla.org/Joomla-Framework/Client/JClientHelper.html JClientHelper on api.joomla.org]
| + | |
| − | <noinclude>[[Category:Development]][[Category:Framework]][[Category:JClientHelper]]</noinclude> | + | |
