JUserHelper: Difference between revisions
From Joomla! Documentation
Bulk upload by Doxiki2 |
m preparing for archive only |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
=={{JVer|11.1}} JUserHelper== | |||
===Description=== | |||
{{ | |||
== | |||
=== | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
!Visibility | |||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
|[[JUserHelper::getProfile | |public | ||
|[[API17:JUserHelper::getProfile|getProfile]] | |||
|Gets the user profile information. | |Gets the user profile information. | ||
|- | |- | ||
|[[JUserHelper::activateUser | |public static | ||
|[[API17:JUserHelper::activateUser|activateUser]] | |||
|Method to activate a user. | |Method to activate a user. | ||
|- | |- | ||
|[[JUserHelper::addUserToGroup | |public static | ||
|[[API17:JUserHelper::addUserToGroup|addUserToGroup]] | |||
|Method to add a user to a group. | |Method to add a user to a group. | ||
|- | |- | ||
|[[JUserHelper::genRandomPassword | |public static | ||
|[[API17:JUserHelper::genRandomPassword|genRandomPassword]] | |||
|Generate a random password. | |Generate a random password. | ||
|- | |- | ||
|[[JUserHelper::getCryptedPassword | |public static | ||
|[[API17:JUserHelper::getCryptedPassword|getCryptedPassword]] | |||
|Formats a password using the current encryption. | |Formats a password using the current encryption. | ||
|- | |- | ||
|[[JUserHelper::getSalt | |public static | ||
|[[API17:JUserHelper::getSalt|getSalt]] | |||
|Returns a salt for the appropriate kind of password encryption. | |Returns a salt for the appropriate kind of password encryption. | ||
|- | |- | ||
|[[JUserHelper::getUserGroups | |public static | ||
|[[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. | ||
|- | |- | ||
|[[JUserHelper::getUserId | |public static | ||
|[[API17:JUserHelper::getUserId|getUserId]] | |||
|Returns userid if a user exists. | |Returns userid if a user exists. | ||
|- | |- | ||
|[[JUserHelper::removeUserFromGroup | |public static | ||
|[[API17:JUserHelper::removeUserFromGroup|removeUserFromGroup]] | |||
|Method to remove a user from a group. | |Method to remove a user from a group. | ||
|- | |- | ||
|[[JUserHelper::setUserGroups | |public static | ||
|[[API17:JUserHelper::setUserGroups|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=== | ||
* [[ | * {{JVer|11.1}} '''JUserHelper source code''' on [[jplatform:user/helper.php|BitBucket]] | ||
{{ | * {{JVer|11.1}} Subpackage [[API17:Subpackage User|User]] | ||
* [[API17:JUserHelper|Other versions of JUserHelper]] | |||
===Examples=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JUserHelper | category=JUserHelper | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
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