Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
IliasUser Class Reference

Public Member Functions

 __construct ($index, $version, $user_id=false)
 
 readData ()
 
 getStudipUserData ()
 
 getUserArray ()
 
 getId ()
 
 setId ($ilias_user_id)
 
 getStudipId ()
 
 getUsername ()
 
 setUsername ($user_login)
 
 getPassword ()
 
 setPassword ($user_password)
 
 getCategory ()
 
 setCategory ($user_category)
 
 getGender ()
 
 setGender ($user_gender)
 
 getName ()
 
 getFirstname ()
 
 setFirstname ($user_firstname)
 
 getLastname ()
 
 setLastname ($user_lastname)
 
 getEmail ()
 
 setEmail ($user_email)
 
 getUserType ()
 
 setUserType ($user_type)
 
 setConnection ($user_type)
 
 unsetConnection ($ignore_usertype=false)
 
 isConnected ()
 
 getToken ()
 

Data Fields

const USER_TYPE_ORIGINAL = '1'
 
const USER_TYPE_CREATED = '0'
 
 $index
 
 $version
 
 $id
 
 $studip_id
 
 $studip_login
 
 $studip_password
 
 $login
 
 $external_password
 
 $category
 
 $gender
 
 $title_front
 
 $title_rear
 
 $title
 
 $firstname
 
 $lastname
 
 $institution
 
 $street
 
 $country
 
 $phone_home
 
 $fax
 
 $matriculation
 
 $email
 
 $type
 
 $is_connected
 
 $auth_plugin
 

Constructor & Destructor Documentation

__construct (   $index,
  $version,
  $user_id = false 
)

constructor

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

Parameters
string$indexILIAS installation index

Member Function Documentation

getCategory ( )

get user category

returns id public

Returns
string id
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
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
getToken ( )

get authentication token

generates authentication token and updates auth_extern public

getUserArray ( )

get array of user account data

returns array of user account data public

Returns
array user account data
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
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 public

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
setId (   $ilias_user_id)

set id

returns id

Returns
string id
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
unsetConnection (   $ignore_usertype = false)

remove connection for user-account

deletes user-connection from database (only for manually connected user) public

Field Documentation

$auth_plugin
$category
$country
$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
$version
const USER_TYPE_CREATED = '0'
const USER_TYPE_ORIGINAL = '1'

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