Difference between revisions of "JUserHelper"
From Joomla! Documentation
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JUserHelper== | ||
| + | ===Description=== | ||
| + | {{Description:JUserHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JUserHelper|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JUserHelper|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JUserHelper::getProfile/11.1|getProfile]] | |[[JUserHelper::getProfile/11.1|getProfile]] | ||
|Gets the user profile information. | |Gets the user profile information. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::activateUser/11.1|activateUser]] | |[[JUserHelper::activateUser/11.1|activateUser]] | ||
|Method to activate a user. | |Method to activate a user. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::addUserToGroup/11.1|addUserToGroup]] | |[[JUserHelper::addUserToGroup/11.1|addUserToGroup]] | ||
|Method to add a user to a group. | |Method to add a user to a group. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::genRandomPassword/11.1|genRandomPassword]] | |[[JUserHelper::genRandomPassword/11.1|genRandomPassword]] | ||
|Generate a random password. | |Generate a random password. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::getCryptedPassword/11.1|getCryptedPassword]] | |[[JUserHelper::getCryptedPassword/11.1|getCryptedPassword]] | ||
|Formats a password using the current encryption. | |Formats a password using the current encryption. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::getSalt/11.1|getSalt]] | |[[JUserHelper::getSalt/11.1|getSalt]] | ||
|Returns a salt for the appropriate kind of password encryption. | |Returns a salt for the appropriate kind of password encryption. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::getUserGroups/11.1|getUserGroups]] | |[[JUserHelper::getUserGroups/11.1|getUserGroups]] | ||
|Method to get a list of groups a user is in. | |Method to get a list of groups a user is in. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::getUserId/11.1|getUserId]] | |[[JUserHelper::getUserId/11.1|getUserId]] | ||
|Returns userid if a user exists. | |Returns userid if a user exists. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::removeUserFromGroup/11.1|removeUserFromGroup]] | |[[JUserHelper::removeUserFromGroup/11.1|removeUserFromGroup]] | ||
|Method to remove a user from a group. | |Method to remove a user from a group. | ||
|- | |- | ||
| + | |public static | ||
|[[JUserHelper::setUserGroups/11.1|setUserGroups]] | |[[JUserHelper::setUserGroups/11.1|setUserGroups]] | ||
|Method to set the groups for a user. | |Method to set the groups for a user. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/user/helper.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.user.helper' );</source> | <source lang="php">jimport( 'joomla.user.helper' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JUserHelper source code | + | * {{JVer|11.1}} '''JUserHelper source code''' on [[jplatform:user/helper.php|BitBucket]] |
| − | * [[JUserHelper|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage User/11.1|User]] |
| + | * [[JUserHelper|Other versions of JUserHelper]] | ||
{{SeeAlso:JUserHelper}} | {{SeeAlso:JUserHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JUserHelper|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JUserHelper|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 65: | Line 73: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JUserHelper]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JUserHelper]]</noinclude> | ||
Revision as of 18:10, 27 April 2011
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JUserHelper[edit]
Description[edit]
Template:Description:JUserHelper [Edit Descripton]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | getProfile | Gets the user profile information. |
| public static | activateUser | Method to activate a user. |
| public static | addUserToGroup | Method to add a user to a group. |
| public static | genRandomPassword | Generate a random password. |
| public static | getCryptedPassword | Formats a password using the current encryption. |
| public static | getSalt | Returns a salt for the appropriate kind of password encryption. |
| public static | getUserGroups | Method to get a list of groups a user is in. |
| public static | getUserId | Returns userid if a user exists. |
| public static | removeUserFromGroup | Method to remove a user from a group. |
| public static | setUserGroups | Method to set the groups for a user. |
- Defined in libraries/joomla/user/helper.php
Importing[edit]
jimport( 'joomla.user.helper' );See also[edit]
- JUserHelper source code on BitBucket
- Subpackage User
- Other versions of JUserHelper
Template:SeeAlso:JUserHelper [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />