JUserHelper: Difference between revisions
From Joomla! Documentation
Updated to r1448:247ba8d88526 |
m preparing for archive only |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JUserHelper== | =={{JVer|11.1}} JUserHelper== | ||
===Description=== | ===Description=== | ||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
|[[JUserHelper::getProfile | |[[API17:JUserHelper::getProfile|getProfile]] | ||
|Gets the user profile information. | |Gets the user profile information. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::activateUser | |[[API17:JUserHelper::activateUser|activateUser]] | ||
|Method to activate a user. | |Method to activate a user. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::addUserToGroup | |[[API17:JUserHelper::addUserToGroup|addUserToGroup]] | ||
|Method to add a user to a group. | |Method to add a user to a group. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::genRandomPassword | |[[API17:JUserHelper::genRandomPassword|genRandomPassword]] | ||
|Generate a random password. | |Generate a random password. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::getCryptedPassword | |[[API17:JUserHelper::getCryptedPassword|getCryptedPassword]] | ||
|Formats a password using the current encryption. | |Formats a password using the current encryption. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::getSalt | |[[API17:JUserHelper::getSalt|getSalt]] | ||
|Returns a salt for the appropriate kind of password encryption. | |Returns a salt for the appropriate kind of password encryption. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::getUserGroups | |[[API17:JUserHelper::getUserGroups|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 | |public static | ||
|[[JUserHelper::getUserId | |[[API17:JUserHelper::getUserId|getUserId]] | ||
|Returns userid if a user exists. | |Returns userid if a user exists. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::removeUserFromGroup | |[[API17:JUserHelper::removeUserFromGroup|removeUserFromGroup]] | ||
|Method to remove a user from a group. | |Method to remove a user from a group. | ||
|- | |- | ||
|public static | |public static | ||
|[[JUserHelper::setUserGroups | |[[API17:JUserHelper::setUserGroups|setUserGroups]] | ||
|Method to set the groups for a user. | |Method to set the groups for a user. | ||
|- | |- | ||
| Line 59: | Line 57: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JUserHelper source code''' on [[jplatform:user/helper.php|BitBucket]] | * {{JVer|11.1}} '''JUserHelper source code''' on [[jplatform:user/helper.php|BitBucket]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage User | * {{JVer|11.1}} Subpackage [[API17:Subpackage User|User]] | ||
* [[JUserHelper|Other versions of JUserHelper]] | * [[API17:JUserHelper|Other versions of JUserHelper]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JUserHelper | category=JUserHelper | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| Line 76: | Line 72: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude> | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> | ||
Latest revision as of 03:55, 25 March 2017
JUserHelper
Description
Methods
| 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
jimport( 'joomla.user.helper' );
See also
- JUserHelper source code on BitBucket
- Subpackage User
- Other versions of JUserHelper
User contributed notes
Code Examples