ILIAS
Release_5_0_x_branch Revision 61816
|
Class ilObjSetupUser A class derived from ilObjUser for authentication purposes in the ILIAS setup. More...
Public Member Functions | |
__construct () | |
Constructor. | |
Public Member Functions inherited from ilObjUser | |
__construct ($a_user_id=0, $a_call_by_reference=false) | |
Constructor public. | |
read () | |
loads a record "user" from database private | |
getPasswordEncodingType () | |
setPasswordEncodingType ($password_encryption_type) | |
getPasswordSalt () | |
setPasswordSalt ($password_salt) | |
assignData ($a_data) | |
loads a record "user" from array public | |
writeAccepted () | |
write accept date of user agreement to db | |
_lookupFullname ($a_user_id) | |
Lookup Full Name. | |
_lookupIm ($a_user_id, $a_type) | |
Lookup IM. | |
_lookupEmail ($a_user_id) | |
Lookup email. | |
_lookupClientIP ($a_user_id) | |
Lookup client ip. | |
_lookupFields ($a_user_id) | |
lookup fields (deprecated; use more specific methods instead) | |
_lookupLogin ($a_user_id) | |
lookup login | |
_lookupExternalAccount ($a_user_id) | |
lookup external account for login and authmethod | |
_lookupLastLogin ($a_user_id) | |
lookup last login | |
refreshLogin () | |
updates the login data of a "user" // TODO set date with now() should be enough public | |
updateLogin ($a_login) | |
update login name | |
writePref ($a_keyword, $a_value) | |
write userpref to user table private | |
deletePref ($a_keyword) | |
Deletes a userpref value of the user from the database public. | |
_deleteAllPref ($a_user_id) | |
Deletes a userpref value of the user from the database public. | |
writePrefs () | |
write all userprefs private | |
getTimeZone () | |
get timezone of user | |
getTimeFormat () | |
get time format | |
getDateFormat () | |
get date format | |
setPref ($a_keyword, $a_value) | |
set a user preference | |
getPref ($a_keyword) | |
get a user preference | |
_lookupPref ($a_usr_id, $a_keyword) | |
readPrefs () | |
get all user preferences private | |
delete () | |
deletes a user public | |
setFullname ($a_title="", $a_firstname="", $a_lastname="") | |
builds a string with title + firstname + lastname method is used to build fullname in member variable $this->fullname. | |
getFullname ($a_max_strlen=0) | |
get fullname public | |
setLogin ($a_str) | |
set login / username public | |
getLogin () | |
get login / username public | |
setPasswd ($a_str, $a_type=IL_PASSWD_PLAIN) | |
set password public | |
getPasswd () | |
get password | |
getPasswdType () | |
get password type | |
setGender ($a_str) | |
set gender public | |
getGender () | |
get gender public | |
setUTitle ($a_str) | |
set user title (note: don't mix up this method with setTitle() that is derived from ilObject and sets the user object's title) public | |
getUTitle () | |
get user title (note: don't mix up this method with getTitle() that is derived from ilObject and gets the user object's title) public | |
setFirstname ($a_str) | |
set firstname public | |
getFirstname () | |
get firstname public | |
setLastname ($a_str) | |
set lastame public | |
getLastname () | |
get lastname public | |
setInstitution ($a_str) | |
set institution public | |
getInstitution () | |
get institution public | |
setDepartment ($a_str) | |
set department public | |
getDepartment () | |
get department public | |
setStreet ($a_str) | |
set street public | |
getStreet () | |
get street public | |
setCity ($a_str) | |
set city public | |
getCity () | |
get city public | |
setZipcode ($a_str) | |
set zipcode public | |
getZipcode () | |
get zipcode public | |
setCountry ($a_str) | |
Set country (free text) | |
getCountry () | |
Get country (free text) | |
setSelectedCountry ($a_val) | |
Set selected country (selection drop down) | |
getSelectedCountry () | |
Get selected country (selection drop down) | |
setPhoneOffice ($a_str) | |
set office phone public | |
getPhoneOffice () | |
get office phone public | |
setPhoneHome ($a_str) | |
set home phone public | |
getPhoneHome () | |
get home phone public | |
setPhoneMobile ($a_str) | |
set mobile phone public | |
getPhoneMobile () | |
get mobile phone public | |
setFax ($a_str) | |
set fax public | |
getFax () | |
get fax public | |
setClientIP ($a_str) | |
set client ip number public | |
getClientIP () | |
get client ip number public | |
setMatriculation ($a_str) | |
set matriculation number public | |
getMatriculation () | |
get matriculation number public | |
setEmail ($a_str) | |
set email public | |
getEmail () | |
get email address public | |
setHobby ($a_str) | |
set hobby public | |
getHobby () | |
get hobby public | |
setLanguage ($a_str) | |
set user language public | |
getLanguage () | |
returns a 2char-language-string public | |
setDiskQuota ($a_disk_quota) | |
Sets the minimal disk quota imposed by this user account. | |
getDiskQuota () | |
Returns the minimal disk quota imposed by this user account. | |
getPersonalWorkspaceDiskQuota () | |
setLastPasswordChangeTS ($a_last_password_change_ts) | |
getLastPasswordChangeTS () | |
_writeExternalAccount ($a_usr_id, $a_ext_id) | |
_writeAuthMode ($a_usr_id, $a_auth_mode) | |
getCurrentLanguage () | |
returns the current language (may differ from user's pref setting!) | |
setCurrentLanguage ($a_val) | |
Set current language. | |
setLastLogin ($a_str) | |
set user's last login public | |
getLastLogin () | |
returns last login date public | |
setLastUpdate ($a_str) | |
set last update of user data set public | |
getLastUpdate () | |
setComment ($a_str) | |
set referral comment public | |
getComment () | |
get referral comment public | |
setApproveDate ($a_str) | |
set date the user account was activated null indicates that the user has not yet been activated public | |
getApproveDate () | |
get the date when the user account was approved public | |
getAgreeDate () | |
get the date when the user accepted the user agreement public | |
setAgreeDate ($a_str) | |
set date the user account was accepted by the user nullindicates that the user has not accepted his account public | |
setActive ($a_active, $a_owner=0) | |
set user active state and updates system fields appropriately public | |
getActive () | |
get user active state public | |
_lookupActive ($a_usr_id) | |
Check user account active. | |
syncActive () | |
synchronizes current and stored user active values for the owner value to be set correctly, this function should only be called when an admin is approving a user account public | |
getStoredActive ($a_id) | |
get user active state | |
setSkin ($a_str) | |
set user skin (template set) public | |
setTimeLimitOwner ($a_owner) | |
getTimeLimitOwner () | |
setTimeLimitFrom ($a_from) | |
getTimeLimitFrom () | |
setTimeLimitUntil ($a_until) | |
getTimeLimitUntil () | |
setTimeLimitUnlimited ($a_unlimited) | |
getTimeLimitUnlimited () | |
setTimeLimitMessage ($a_time_limit_message) | |
getTimeLimitMessage () | |
setLoginAttempts ($a_login_attempts) | |
getLoginAttempts () | |
checkTimeLimit () | |
setProfileIncomplete ($a_prof_inc) | |
getProfileIncomplete () | |
isPasswordChangeDemanded () | |
isPasswordExpired () | |
getPasswordAge () | |
setLastPasswordChangeToNow () | |
resetLastPasswordChange () | |
setLatitude ($a_latitude) | |
Set Latitude. | |
getLatitude () | |
Get Latitude. | |
setLongitude ($a_longitude) | |
Set Longitude. | |
getLongitude () | |
Get Longitude. | |
setLocationZoom ($a_locationzoom) | |
Set Location Zoom. | |
getLocationZoom () | |
Get Location Zoom. | |
& | getAppliedUsers () |
isChild ($a_usr_id) | |
__readAppliedUsers ($a_parent_id) | |
checkUserId () | |
isCurrentUserActive () | |
getUserIdByLogin ($a_login) | |
getLoginByUserId ($a_userid) | |
_getNumberOfUsersForStyle ($a_skin, $a_style) | |
skins and styles | |
_getAllUserAssignedStyles () | |
skins and styles | |
_moveUsersToStyle ($a_from_skin, $a_from_style, $a_to_skin, $a_to_style) | |
skins and styles | |
addDesktopItem ($a_item_id, $a_type, $a_par="") | |
add an item to user's personal desktop | |
setDesktopItemParameters ($a_item_id, $a_type, $a_par) | |
set parameters of a desktop item entry | |
dropDesktopItem ($a_item_id, $a_type) | |
drop an item from user's personal desktop | |
isDesktopItem ($a_item_id, $a_type) | |
check wether an item is on the users desktop or not | |
getDesktopItems ($a_types="") | |
addObjectToClipboard ($a_item_id, $a_type, $a_title, $a_parent=0, $a_time=0, $a_order_nr=0) | |
add an item to user's personal clipboard | |
addToPCClipboard ($a_content, $a_time, $a_nr) | |
Add a page content item to PC clipboard (should go to another class) | |
getPCClipboardContent () | |
Add a page content item to PC clipboard (should go to another class) | |
clipboardHasObjectsOfType ($a_type) | |
Check whether clipboard has objects of a certain type. | |
clipboardDeleteObjectsOfType ($a_type) | |
Delete objects of type for user. | |
clipboardDeleteAll () | |
Delete objects of type for user. | |
getClipboardObjects ($a_type="", $a_top_nodes_only=false) | |
get all clipboard objects of user and specified type | |
getClipboardChilds ($a_parent, $a_insert_time) | |
Get childs of an item. | |
_getUsersForClipboadObject ($a_type, $a_id) | |
get all users, that have a certain object within their clipboard | |
removeObjectFromClipboard ($a_item_id, $a_type) | |
remove object from user's personal clipboard | |
_getImportedUserId ($i2_id) | |
setAuthMode ($a_str) | |
set auth mode public | |
getAuthMode ($a_auth_key=false) | |
get auth mode public | |
setExternalAccount ($a_str) | |
set external account | |
getExternalAccount () | |
get external account | |
_getNumberOfUsersPerAuthMode () | |
get number of users per auth mode | |
_getLocalAccountsForEmail ($a_email) | |
check whether external account and authentication method matches with a user | |
_uploadPersonalPicture ($tmp_file, $obj_id) | |
Create a personal picture image file from a temporary image file. | |
getPersonalPicturePath ($a_size="small", $a_force_pic=false) | |
Get path to personal picture. | |
removeUserPicture ($a_do_update=true) | |
Remove user picture. | |
setUserDefinedData ($a_data) | |
getUserDefinedData () | |
updateUserDefinedFields () | |
readUserDefinedFields () | |
addUserDefinedFieldEntry () | |
deleteUserDefinedFieldEntries () | |
setInstantMessengerId ($a_im_type, $a_im_id) | |
getInstantMessengerId ($a_im_type) | |
setDelicious ($a_delicious) | |
getDelicious () | |
_lookupFeedHash ($a_user_id, $a_create=false) | |
Lookup news feed hash for user. | |
_getFeedPass ($a_user_id) | |
Lookup news feed password for user. | |
_setFeedPass ($a_user_id, $a_password) | |
Set news feed password for user. | |
hasPublicProfile () | |
returns true if public is profile, false otherwise | |
getPublicName () | |
returns firstname lastname and login if profile is public, login otherwise | |
setBirthday ($a_birthday) | |
getBirthday () | |
resetOwner () | |
isCaptchaVerified () | |
Is user captcha verified? | |
setCaptchaVerified ($a_val) | |
Set captcha verified. | |
exportPersonalData () | |
Export personal data. | |
getPersonalDataExportFile () | |
Get personal data export file. | |
sendPersonalDataFile () | |
Send personal data file. | |
importPersonalData ($a_file, $a_profile_data, $a_settings, $a_bookmarks, $a_notes, $a_calendar) | |
Import personal data. | |
setInactivationDate ($inactivation_date) | |
setter for inactivation date | |
getInactivationDate () | |
getter for inactivation date | |
hasToAcceptTermsOfServiceInSession ($status=null) | |
isAnonymous () | |
activateDeletionFlag () | |
removeDeletionFlag () | |
hasDeletionFlag () | |
setIsSelfRegistered ($status) | |
isSelfRegistered () | |
setGeneralInterests (array $value=null) | |
Set general interests. | |
getGeneralInterests () | |
Get general interests. | |
getGeneralInterestsAsText () | |
Get general interests as plain text. | |
setOfferingHelp (array $value=null) | |
Set help offering. | |
getOfferingHelp () | |
Get help offering. | |
getOfferingHelpAsText () | |
Get help offering as plain text. | |
setLookingForHelp (array $value=null) | |
Set help looking for. | |
getLookingForHelp () | |
Get help looking for. | |
getLookingForHelpAsText () | |
Get help looking for as plain text. | |
updateMultiTextFields ($a_create=false) | |
Write multi-text values to DB. | |
Public Member Functions inherited from ilObject | |
ilObject ($a_id=0, $a_reference=true) | |
Constructor public. | |
withReferences () | |
determines wehter objects are referenced or not (got ref ids or not) | |
read ($a_force_db=false) | |
read object data from db into object | |
getId () | |
get object id public | |
setId ($a_id) | |
set object id public | |
setRefId ($a_id) | |
set reference id public | |
getRefId () | |
get reference id public | |
getType () | |
get object type public | |
setType ($a_type) | |
set object type public | |
getPresentationTitle () | |
get presentation title Normally same as title Overwritten for sessions | |
getTitle () | |
get object title public | |
getUntranslatedTitle () | |
get untranslated object title public | |
setTitle ($a_title) | |
set object title | |
getDescription () | |
get object description | |
setDescription ($a_desc) | |
set object description | |
getLongDescription () | |
get object long description (stored in object_description) | |
getImportId () | |
get import id | |
setImportId ($a_import_id) | |
set import id | |
getOwner () | |
get object owner | |
getOwnerName () | |
_lookupOwnerName ($a_owner_id) | |
lookup owner name for owner id | |
setOwner ($a_owner) | |
set object owner | |
getCreateDate () | |
get create date public | |
getLastUpdateDate () | |
get last update date public | |
getDiskUsage () | |
Gets the disk usage of the object in bytes. | |
setObjDataRecord ($a_record) | |
set object_data record (note: this method should only be called from the ilObjectFactory class) | |
create () | |
create | |
update () | |
update object in db | |
MDUpdateListener ($a_element) | |
Meta data update listener. | |
createMetaData () | |
create meta data entry | |
updateMetaData () | |
update meta data entry | |
deleteMetaData () | |
delete meta data entry | |
updateOwner () | |
update owner of object in db | |
_getIdForImportId ($a_import_id) | |
get current object id for import id (static) | |
_lookupOwner ($a_id) | |
lookup object owner | |
_lookupLastUpdate ($a_id, $a_as_string=false) | |
lookup last update | |
_getLastUpdateOfObjects ($a_objs) | |
Get last update for a set of media objects. | |
_setDeletedDate ($a_ref_id) | |
only called in ilTree::saveSubTree | |
_resetDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes | |
_lookupDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes | |
_writeTitle ($a_obj_id, $a_title) | |
write title to db (static) | |
_writeDescription ($a_obj_id, $a_desc) | |
write description to db (static) | |
_writeImportId ($a_obj_id, $a_import_id) | |
write import id to db (static) | |
_isInTrash ($a_ref_id) | |
checks wether object is in trash | |
_hasUntrashedReference ($a_obj_id) | |
checks wether an object has at least one reference that is not in trash | |
_getObjectsDataForType ($a_type, $a_omit_trash=false) | |
get all objects of a certain type | |
putInTree ($a_parent_ref) | |
maybe this method should be in tree object!? | |
setPermissions ($a_parent_ref) | |
set permissions of object | |
setParentRolePermissions ($a_parent_ref) | |
Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. | |
createReference () | |
creates reference for object | |
countReferences () | |
count references of object | |
initDefaultRoles () | |
init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public | |
applyDidacticTemplate ($a_tpl_id) | |
Apply template. | |
notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
notifys an object about an event occured Based on the event passed, each object may decide how it reacts. | |
setRegisterMode ($a_bool) | |
isUserRegistered ($a_user_id=0) | |
requireRegistration () | |
getXMLZip () | |
getHTMLDirectory () | |
cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
Clone object permissions, put in tree ... | |
appendCopyInfo ($a_target_id, $a_copy_id) | |
Prepend Copy info if object with same name exists in that container. | |
cloneDependencies ($a_target_id, $a_copy_id) | |
Clone object dependencies. | |
cloneMetaData ($target_obj) | |
Copy meta data. | |
_lookupCreationDate ($a_id) | |
Lookup creation date. |
Additional Inherited Members | |
Static Public Member Functions inherited from ilObjUser | |
static | _lookupGender ($a_user_id) |
Lookup gender. | |
static | _lookupName ($a_user_id) |
lookup user name | |
static | _lookupId ($a_user_str) |
lookup id by login | |
static | _doesLoginnameExistInHistory ($a_login) |
Checks wether the passed loginname already exists in history. | |
static | _getLastHistoryDataByUserId ($a_usr_id) |
Returns the last used loginname and the changedate of the passed user_id. | |
static | _writePref ($a_usr_id, $a_keyword, $a_value) |
static | lookupMatriculation ($a_usr_id) |
Lookup matriculation. | |
static | _lookupLanguage ($a_usr_id) |
static | hasActiveSession ($a_user_id) |
Check for simultaneous login. | |
_getUserIdsByEmail ($a_email) | |
STATIC METHOD get all user_ids of an email address. | |
getUserIdByEmail ($a_email) | |
STATIC METHOD get the user_id of an email address. | |
static | searchUsers ($a_search_str, $active=1, $a_return_ids_only=false, $filter_settings=FALSE) |
STATIC METHOD get the user_ids which correspond a search string. | |
_getAllUserLogins (&$ilias) | |
STATIC METHOD get all user logins. | |
static | _readUsersProfileData ($a_user_ids) |
STATIC METHOD get user data of selected users. | |
_getAllUserData ($a_fields=NULL, $active=-1) | |
STATIC METHOD get all user data. | |
static | _addDesktopItem ($a_usr_id, $a_item_id, $a_type, $a_par="") |
add an item to user's personal desktop | |
static | _dropDesktopItem ($a_usr_id, $a_item_id, $a_type) |
drop an item from user's personal desktop | |
static | _removeItemFromDesktops ($a_id) |
removes object from all user's desktops public | |
static | _isDesktopItem ($a_usr_id, $a_item_id, $a_type) |
check wether an item is on the users desktop or not | |
static | preloadIsDesktopItem ($a_usr_id, $a_item_ids) |
Preload desktop item information. | |
static | _lookupDesktopItems ($user_id, $a_types="") |
get all desktop items of user and specified type | |
static | _getExternalAccountsByAuthMode ($a_auth_mode, $a_read_auth_default=false) |
Get list of external account by authentication method Note: If login == ext_account for two user with auth_mode 'default' and auth_mode 'ldap' The ldap auth mode chosen. | |
static | _toggleActiveStatusOfUsers ($a_usr_ids, $a_status) |
Toggle active status of users. | |
static | _lookupAuthMode ($a_usr_id) |
lookup auth mode | |
static | _checkExternalAuthAccount ($a_auth, $a_account) |
check whether external account and authentication method matches with a user | |
static | _getPersonalPicturePath ($a_usr_id, $a_size="small", $a_force_pic=false, $a_prevent_no_photo_image=false) |
Get path to personal picture. | |
static | copyProfilePicturesToDirectory ($a_user_id, $a_dir) |
Get profile picture direcotory. | |
static | _loginExists ($a_login, $a_user_id=0) |
check if a login name already exists You may exclude a user from the check by giving his user id as 2nd paramter public static | |
static | _externalAccountExists ($a_external_account, $a_auth_mode) |
Check if an external account name already exists. | |
static | _getUsersForRole ($role_id, $active=-1) |
return array of complete users which belong to a specific role | |
static | _getUsersForFolder ($ref_id, $active) |
get users for a category or from system folder | |
static | _getUsersForGroup ($a_mem_ids, $active=-1) |
return user data for group members | |
static | _getUsersForIds ($a_mem_ids, $active=-1, $timelimitowner=-1) |
return user data for given user id | |
static | _getUserData ($a_internalids) |
return user data for given user ids | |
static | _getPreferences ($user_id) |
get preferences for user | |
static | _resetLoginAttempts ($a_usr_id) |
static | _getLoginAttempts ($a_usr_id) |
static | _incrementLoginAttempts ($a_usr_id) |
static | _setUserInactive ($a_usr_id) |
static | _writeHistory ($a_usr_id, $a_login) |
static | _getAssociatedUsersOnline ($a_user_id, $a_no_anonymous=false) |
reads all active sessions from db and returns users that are online and who have a local role in a group or a course for which the | |
static | _generateRegistrationHash ($a_usr_id) |
Generates a unique hashcode for activating a user profile after registration. | |
static | _verifyRegistrationHash ($a_hash) |
Verifies a registration hash. | |
static | _getUserIdsByInactivityPeriod ($period) |
get ids of all users that have been inactive for at least the given period | |
static | _getUserIdsByInactivationPeriod ($period) |
get ids of all users that have been inactivated since at least the given period | |
static | _updateLastLogin ($a_usr_id, $a_last_login=null) |
STATIC METHOD updates the last_login field of user with given id to given or current date. | |
static | getFirstLettersOfLastnames () |
Get first letters of all lastnames. | |
static | userExists ($a_usr_ids=array()) |
static | findInterests ($a_term, $a_user_id=null, $a_field_id=null) |
Data Fields inherited from ilObjUser | |
$login | |
all user related data in single vars public | |
$gender | |
$utitle | |
$firstname | |
$lastname | |
$fullname | |
$institution | |
$department | |
$street | |
$city | |
$zipcode | |
$country | |
$sel_country | |
$phone_office | |
$phone_home | |
$phone_mobile | |
$fax | |
$hobby | |
$matriculation | |
$referral_comment | |
$approve_date = null | |
$agree_date = null | |
$active | |
$client_ip | |
$auth_mode | |
$im_icq | |
$im_yahoo | |
$im_msn | |
$im_aim | |
$im_skype | |
$im_jabber | |
$im_voip | |
$delicious | |
$latitude | |
$longitude | |
$loc_zoom | |
$last_password_change_ts | |
$login_attempts | |
$user_defined_data = array() | |
$prefs | |
$skin | |
$default_role | |
$ilias | |
Static Public Attributes inherited from ilObjUser | |
static | $is_desktop_item_loaded |
static | $is_desktop_item_cache |
Protected Member Functions inherited from ilObjUser | |
buildTextFromArray ($a_attr) | |
Convert multi-text values to plain text. | |
readMultiTextFields () | |
Fetch multi-text values from DB. | |
deleteMultiTextFields () | |
Remove multi-text values from DB. | |
Protected Attributes inherited from ilObjUser | |
$passwd | |
$passwd_type | |
$password_encoding_type | |
$password_salt = null | |
$birthday | |
$inactivation_date = null | |
$interests_general | |
$interests_help_offered | |
$interests_help_looking | |
Static Protected Attributes inherited from ilObjUser | |
static | $personal_image_cache = array() |
Class ilObjSetupUser A class derived from ilObjUser for authentication purposes in the ILIAS setup.
Definition at line 10 of file class.ilObjSetupUser.php.
ilObjSetupUser::__construct | ( | ) |
Constructor.
Definition at line 15 of file class.ilObjSetupUser.php.