| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2007 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 645 lines (21 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| addUserToGroup($userId, $groupId) X-Ref |
| Method to add a user to a group. param: integer $userId The id of the user. param: integer $groupId The id of the group. return: boolean True on success |
| getUserGroups($userId) X-Ref |
| Method to get a list of groups a user is in. param: integer $userId The id of the user. return: array List of groups |
| removeUserFromGroup($userId, $groupId) X-Ref |
| Method to remove a user from a group. param: integer $userId The id of the user. param: integer $groupId The id of the group. return: boolean True on success |
| setUserGroups($userId, $groups) X-Ref |
| Method to set the groups for a user. param: integer $userId The id of the user. param: array $groups An array of group ids to put the user in. return: boolean True on success |
| getProfile($userId = 0) X-Ref |
| Gets the user profile information param: integer $userId The id of the user. return: object |
| activateUser($activation) X-Ref |
| Method to activate a user param: string $activation Activation string return: boolean True on success |
| getUserId($username) X-Ref |
| Returns userid if a user exists param: string $username The username to search on. return: integer The user id or 0 if not found. |
| hashPassword($password, $algorithm = self::HASH_BCRYPT, array $options = array() X-Ref |
| Hashes a password using the current encryption. param: string $password The plaintext password to encrypt. param: string|integer $algorithm The hashing algorithm to use, represented by `HASH_*` class constants, or a container service ID. param: array $options The options for the algorithm to use. return: string The encrypted password. |
| verifyPassword($password, $hash, $userId = 0) X-Ref |
| Formats a password using the current encryption. If the user ID is given and the hash does not fit the current hashing algorithm, it automatically updates the hash. param: string $password The plaintext password to check. param: string $hash The hash to verify against. param: integer $userId ID of the user if the password hash should be updated return: boolean True if the password and hash match, false otherwise |
| genRandomPassword($length = 8) X-Ref |
| Generate a random password param: integer $length Length of the password to generate return: string Random Password |
| getShortHashedUserAgent() X-Ref |
| Method to get a hashed user agent string that does not include browser version. Used when frequent version changes cause problems. return: string A hashed user agent string with version replaced by 'abcd' |
| checkSuperUserInUsers(array $userIds) X-Ref |
| Check if there is a super user in the user ids. param: array $userIds An array of user IDs on which to operate return: boolean True on success, false on failure |
| destroyUserSessions($userId, $keepCurrent = false, $clientId = null) X-Ref |
| Destroy all active session for a given user id param: int $userId Id of user param: boolean $keepCurrent Keep the session of the currently acting user param: int $clientId Application client id return: boolean |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |