class UserWrapper

Wrapper class for UserHelper

Methods

boolean
addUserToGroup( integer $userId, integer $groupId)

Helper wrapper method for addUserToGroup

array
getUserGroups( integer $userId)

Helper wrapper method for getUserGroups

boolean
removeUserFromGroup( integer $userId, integer $groupId)

Helper wrapper method for removeUserFromGroup

boolean
setUserGroups( integer $userId, array $groups)

Helper wrapper method for setUserGroups

object
getProfile( integer $userId)

Helper wrapper method for getProfile

boolean
activateUser( string $activation)

Helper wrapper method for activateUser

integer
getUserId( string $username)

Helper wrapper method for getUserId

string
hashPassword( string $password, integer $algorithm = PASSWORD_BCRYPT, array $options = array())

Helper wrapper method for hashPassword

boolean
verifyPassword( string $password, string $hash, integer $user_id)

Helper wrapper method for verifyPassword

string
getCryptedPassword( string $plaintext, string $salt = '', string $encryption = 'md5-hex', boolean $show_encrypt = false)

Helper wrapper method for getCryptedPassword

string
getSalt( string $encryption = 'md5-hex', string $seed = '', string $plaintext = '')

Helper wrapper method for getSalt

string
genRandomPassword( integer $length = 8)

Helper wrapper method for genRandomPassword

boolean
invalidateCookie( string $userId, string $cookieName)

Helper wrapper method for invalidateCookie

mixed
clearExpiredTokens()

Helper wrapper method for clearExpiredTokens

mixed
getRememberCookieData()

Helper wrapper method for getRememberCookieData

string
getShortHashedUserAgent()

Helper wrapper method for getShortHashedUserAgent

Details

boolean addUserToGroup( integer $userId, integer $groupId)

Helper wrapper method for addUserToGroup

Parameters

integer $userId The id of the user.
integer $groupId The id of the group.

Return Value

boolean True on success

Exceptions

RuntimeException

See also

UserHelper::addUserToGroup()

array getUserGroups( integer $userId)

Helper wrapper method for getUserGroups

Parameters

integer $userId The id of the user.

Return Value

array List of groups

See also

UserHelper::addUserToGroup()

boolean removeUserFromGroup( integer $userId, integer $groupId)

Helper wrapper method for removeUserFromGroup

Parameters

integer $userId The id of the user.
integer $groupId The id of the group.

Return Value

boolean True on success

See also

UserHelper::removeUserFromGroup()

boolean setUserGroups( integer $userId, array $groups)

Helper wrapper method for setUserGroups

Parameters

integer $userId The id of the user.
array $groups An array of group ids to put the user in.

Return Value

boolean True on success

See also

UserHelper::setUserGroups()

object getProfile( integer $userId)

Helper wrapper method for getProfile

Parameters

integer $userId The id of the user.

Return Value

object

See also

UserHelper::getProfile()

boolean activateUser( string $activation)

Helper wrapper method for activateUser

Parameters

string $activation Activation string

Return Value

boolean True on success

See also

UserHelper::activateUser()

integer getUserId( string $username)

Helper wrapper method for getUserId

Parameters

string $username The username to search on.

Return Value

integer The user id or 0 if not found.

See also

UserHelper::getUserId()

string hashPassword( string $password, integer $algorithm = PASSWORD_BCRYPT, array $options = array())

Helper wrapper method for hashPassword

Parameters

string $password The plaintext password to encrypt.
integer $algorithm The hashing algorithm to use, represented by PASSWORD_* constants.
array $options The options for the algorithm to use.

Return Value

string The encrypted password.

See also

UserHelper::hashPassword()

boolean verifyPassword( string $password, string $hash, integer $user_id)

Helper wrapper method for verifyPassword

Parameters

string $password The plaintext password to check.
string $hash The hash to verify against.
integer $user_id ID of the user if the password hash should be updated

Return Value

boolean True if the password and hash match, false otherwise

See also

UserHelper::verifyPassword()

string getCryptedPassword( string $plaintext, string $salt = '', string $encryption = 'md5-hex', boolean $show_encrypt = false)

Helper wrapper method for getCryptedPassword

Parameters

string $plaintext The plaintext password to encrypt.
string $salt The salt to use to encrypt the password. [] If not present, a new salt will be generated.
string $encryption The kind of password encryption to use. Defaults to md5-hex.
boolean $show_encrypt Some password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.

Return Value

string The encrypted password.

See also

UserHelper::getCryptedPassword()

string getSalt( string $encryption = 'md5-hex', string $seed = '', string $plaintext = '')

Helper wrapper method for getSalt

Parameters

string $encryption The kind of password encryption to use. Defaults to md5-hex.
string $seed The seed to get the salt from (probably a previously generated password). Defaults to generating a new seed.
string $plaintext The plaintext password that we're generating a salt for. Defaults to none.

Return Value

string The generated or extracted salt.

See also

UserHelper::getSalt()

string genRandomPassword( integer $length = 8)

Helper wrapper method for genRandomPassword

Parameters

integer $length Length of the password to generate

Return Value

string Random Password

See also

UserHelper::genRandomPassword()

boolean invalidateCookie( string $userId, string $cookieName)

Helper wrapper method for invalidateCookie

Parameters

string $userId User ID for this user
string $cookieName Series id (cookie name decoded)

Return Value

boolean True on success

See also

UserHelper::invalidateCookie()

mixed clearExpiredTokens()

Helper wrapper method for clearExpiredTokens

Return Value

mixed Database query result

See also

UserHelper::clearExpiredTokens()

mixed getRememberCookieData()

Helper wrapper method for getRememberCookieData

Return Value

mixed An array of information from an authentication cookie or false if there is no cookie

See also

UserHelper::getRememberCookieData()

string getShortHashedUserAgent()

Helper wrapper method for getShortHashedUserAgent

Return Value

string A hashed user agent string with version replaced by 'abcd'

See also

UserHelper::getShortHashedUserAgent()