Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
ConnectedUser Class Reference
Inheritance diagram for ConnectedUser:
Ilias3ConnectedUser Ilias4ConnectedUser Ilias5ConnectedUser

Public Member Functions

 __construct ($cms, $user_id=false)
 
 readData ()
 
 getStudipUserData ()
 
 newUser ()
 
 updateUser ()
 
 deleteUser ()
 
 getLoginData ($username)
 
 getId ()
 
 getStudipId ()
 
 getUsername ()
 
 setUsername ($user_login)
 
 getPassword ()
 
 setPassword ($user_password)
 
 getCategory ()
 
 setCategory ($user_category)
 
 getCryptedPassword ($password)
 
 verifyLogin ($username, $password)
 
 getGender ()
 
 setGender ($user_gender)
 
 getName ()
 
 getFirstname ()
 
 setFirstname ($user_firstname)
 
 getLastname ()
 
 setLastname ($user_lastname)
 
 getEmail ()
 
 setEmail ($user_email)
 
 getUserType ()
 
 setUserType ($user_type)
 
 setConnection ($user_type)
 
 isConnected ()
 

Data Fields

 $cms_type
 
 $id
 
 $studip_id
 
 $studip_login
 
 $studip_password
 
 $login
 
 $external_password
 
 $category
 
 $gender
 
 $title_front
 
 $title_rear
 
 $title
 
 $firstname
 
 $lastname
 
 $institution
 
 $department
 
 $street
 
 $city
 
 $zipcode
 
 $country
 
 $phone_home
 
 $fax
 
 $matriculation
 
 $email
 
 $type
 
 $is_connected
 
 $db_class
 

Constructor & Destructor Documentation

__construct (   $cms,
  $user_id = false 
)

constructor

init class. don't call directly, class is loaded by ConnectedCMS. public

Parameters
string$cmssystem-type

Member Function Documentation

deleteUser ( )

delete user-account

dummy-method. returns false. must be overwritten by subclass. public

Returns
boolean returns false
getCategory ( )

get user category

returns id public

Returns
string id
getCryptedPassword (   $password)

get crypted password

dummy-method. returns false. must be overwritten by subclass. public

Returns
boolean returns false
getEmail ( )

get email-adress

returns email-adress public

Returns
string email-adress
getFirstname ( )

get firstname

returns firstname public

Returns
string firstname
getGender ( )

get gender

returns gender-setting public

Returns
string gender-setting
getId ( )

get id

returns id public

Returns
string id
getLastname ( )

get lastname

returns lastname public

Returns
string lastname
getLoginData (   $username)

get login-data of user-account

dummy-method. returns false. must be overwritten by subclass. public

Returns
boolean returns false
getName ( )

get full name

returns full name public

Returns
string name
getPassword ( )

get password

returns password public

Returns
string password
getStudipId ( )

get stud.ip user-id

returns id public

Returns
string stud.ip user-id
getStudipUserData ( )

get stud.ip-user-data

gets stud.ip-user-data from database public

Returns
boolean returns false, if no data was found
getUsername ( )

get username

returns username public

Returns
string username
getUserType ( )

get user-type

returns user-type public

Returns
string user-type
isConnected ( )

get connection-status

returns true, if there is a connected user public

Returns
boolean connection-status
newUser ( )

create new user-account

dummy-method. returns false. must be overwritten by subclass. public

Returns
boolean returns false
readData ( )

get data

gets data from database public

Returns
boolean returns false, if no data was found
setCategory (   $user_category)

set user category

sets user category public

Parameters
string$user_categorycategory
setConnection (   $user_type)

save connection for user-account

saves user-connection to database and sets type for actual user

Parameters
string$user_typeuser-type
setEmail (   $user_email)

set email-adress

sets email-adress public

Parameters
string$user_emailemail-adress
setFirstname (   $user_firstname)

set firstname

sets firstname public

Parameters
string$user_firstnamefirstname
setGender (   $user_gender)

set gender

sets gender public

Parameters
string$user_gendergender-setting
setLastname (   $user_lastname)

set lastname

sets lastname public

Parameters
string$user_lastnamelastname
setPassword (   $user_password)

set password

sets password public

Parameters
string$user_passwordpassword
setUsername (   $user_login)

set username

sets username public

Parameters
string$user_loginusername
setUserType (   $user_type)

set user-type

sets user-type public

Parameters
string$user_typeuser-type
updateUser ( )

update user-account

dummy-method. must be overwritten by subclass.

verifyLogin (   $username,
  $password 
)

verify login data

returns true, if login-data is valid public

Parameters
string$usernameusername
string$passwordpassword
Returns
boolean login-validation

Field Documentation

$category
$city
$cms_type
$country
$db_class
$department
$email
$external_password
$fax
$firstname
$gender
$id
$institution
$is_connected
$lastname
$login
$matriculation
$phone_home
$street
$studip_id
$studip_login
$studip_password
$title
$title_front
$title_rear
$type
$zipcode

The documentation for this class was generated from the following file: