Docs For Class rcms

Description

Located in /system/user-classes.php (line 152)

rcms_access
   |
   --rcms_user

Direct descendents

Class	Description
rcms_system

Variable Summary

boolean $logged_in

mixed $profile_defaults

mixed $profile_fields

array $user

mixed $users_cache

Method Summary

void changeProfileField (mixed $username, mixed $field, mixed $value)

boolean checkUserData (string $username, string $password, string $report_to, boolean $hash, link &$userdata)

void createLink (mixed $user, mixed $nick, [mixed $target = ''])

void deleteUser (mixed $username)

void getUserData (mixed $username)

void getUserList ([mixed $expr = '*'], [mixed $id_field = ''])

boolean initializeUser ([string $skipcheck = false])

boolean logInUser (string $username, string $password, boolean $remember)

boolean logOutUser ()

void recoverPassword (mixed $username, mixed $email)

void registerUser (mixed $username, mixed $nickname, mixed $password, mixed $confirm, mixed $email, mixed $userdata)

void updateUser (mixed $username, mixed $nickname, mixed $password, mixed $confirm, mixed $email, mixed $userdata, [mixed $admin = false])

Variables

boolean $logged_in = false (line 163)

This property indicates if user is registered or just a guest

access: public

mixed $profile_defaults = array() (line 155)

mixed $profile_fields = array() (line 154)

array $user = array() (line 171)

This array contain data from user's profile

access: public

mixed $users_cache = null (line 181)

Inherited Variables

Inherited from rcms_access

rcms_access::$level
rcms_access::$rights
rcms_access::$rights_database
rcms_access::$root

Methods

changeProfileField (line 577)

void changeProfileField (mixed $username, mixed $field, mixed $value)

checkUserData (line 288)

This function is an internal private function for class rcms_system

boolean checkUserData (string $username, string $password, string $report_to, boolean $hash, link &$userdata)

string $username
string $password
string $report_to
boolean $hash
link $userdata

createLink (line 592)

void createLink (mixed $user, mixed $nick, [mixed $target = ''])

deleteUser (line 585)

void deleteUser (mixed $username)

getUserData (line 557)

void getUserData (mixed $username)

getUserList (line 562)

void getUserList ([mixed $expr = '*'], [mixed $id_field = ''])

initializeUser (line 190)

This function is an internal private function for class rcms_system

boolean initializeUser ([string $skipcheck = false])

string $skipcheck: Use this parameter to skip userdata checks

logInUser (line 323)

This function check user's data and log in him.

boolean logInUser (string $username, string $password, boolean $remember)

string $username
string $password
boolean $remember

logOutUser (line 345)

This function log out user from system and destroys his cookie.

boolean logOutUser ()

recoverPassword (line 516)

void recoverPassword (mixed $username, mixed $email)

registerUser (line 356)

void registerUser (mixed $username, mixed $nickname, mixed $password, mixed $confirm, mixed $email, mixed $userdata)

updateUser (line 438)

void updateUser (mixed $username, mixed $nickname, mixed $password, mixed $confirm, mixed $email, mixed $userdata, [mixed $admin = false])

Inherited Methods

Inherited From rcms_access

rcms_access::checkForRight()
rcms_access::getRightsForUser()
rcms_access::initialiseAccess()
rcms_access::setRightsForUser()

Class rcms_user

Inherited Variables

Inherited Methods