ILIAS
release_4-3 Revision
|
Public Member Functions | |
ilSoapUserAdministration () | |
login ($client, $username, $password) | |
loginCAS ($client, $PT, $username) | |
loginLDAP ($client, $username, $password) | |
logout ($sid) | |
lookupUser ($sid, $user_name) | |
getUser ($sid, $user_id) | |
updateUser ($sid, $user_data) | |
updatePassword ($sid, $user_id, $new_password) | |
addUser ($sid, $user_data, $global_role_id) | |
deleteUser ($sid, $user_id) | |
__validateUserData (&$user_data, $check_complete=true) | |
__setUserData (&$user_obj, &$user_data) | |
__readUserData (&$usr_obj) | |
__substituteUserData ($user_old, $user_new) | |
importUsers ($sid, $folder_id, $usr_xml, $conflict_rule, $send_account_mail) | |
define ("IL_FAIL_ON_CONFLICT", 1); define ("IL_UPDATE_ON_CONFLICT", 2); define ("IL_IGNORE_ON_CONFLICT", 3); | |
getUsersForContainer ($sid, $ref_id, $attachRoles, $active) | |
return list of users following dtd users_3_7 | |
getUserForRole ($sid, $role_id, $attachRoles, $active) | |
__getImportProtocolAsXML ($a_array) | |
Create XML ResultSet. | |
__getUserMappingAsXML ($a_array) | |
return user mapping as xml | |
searchUser ($sid, $a_keyfields, $query_operator, $a_keyvalues, $attach_roles, $active) | |
return user xml following dtd 3.7 | |
__buildSearchQuery ($a_keyfields, $queryOperator, $a_keyvalues) | |
create search term according to parameters | |
getUserXML ($sid, $a_user_ids, $attach_roles) | |
return user xmls for given user ids (csv separated ids) as xml based on usr dtd. | |
hasNewMail ($sid) | |
getUserIdBySid ($sid) | |
Public Member Functions inherited from ilSoapAdministration | |
ilSoapAdministration ($use_nusoap=true) | |
__checkSession ($sid) | |
initErrorWriter () | |
Overwrite error handler. | |
__explodeSid ($sid) | |
__setMessage ($a_str) | |
__getMessage () | |
__appendMessage ($a_str) | |
__setMessageCode ($a_code) | |
__getMessageCode () | |
initAuth ($sid) | |
initIlias () | |
__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL) | |
__raiseError ($a_message, $a_code) | |
getNIC ($sid) | |
get client information from current as xml result set | |
isFault ($object) | |
checkObjectAccess ($ref_id, $expected_type, $permission, $returnObject=false) | |
check access for ref id: expected type, permission, return object instance if returnobject is true | |
getInstallationInfoXML () | |
getClientInfoXML ($clientid) | |
getClientDetailsXML ($sid, $clientid) |
Protected Member Functions | |
isPermittedRole ($a_folder, $a_role) | |
check if assignment is allowed |
Additional Inherited Members | |
Static Public Member Functions inherited from ilSoapAdministration | |
static | return_bytes ($val) |
calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes | |
Data Fields inherited from ilSoapAdministration | |
$sauth = null | |
$error_method = null | |
Protected Attributes inherited from ilSoapAdministration | |
$soap_check = true |
Definition at line 35 of file class.ilSoapUserAdministration.php.
ilSoapUserAdministration::__buildSearchQuery | ( | $a_keyfields, | |
$queryOperator, | |||
$a_keyvalues | |||
) |
create search term according to parameters
array | of string $a_keyfields | |
string | $queryOperator | |
array | of string $a_keyValues |
Definition at line 1230 of file class.ilSoapUserAdministration.php.
References $query.
Referenced by searchUser().
ilSoapUserAdministration::__getImportProtocolAsXML | ( | $a_array | ) |
Create XML ResultSet.
Definition at line 1074 of file class.ilSoapUserAdministration.php.
References $messages, and ilSoapAdministration\__raiseError().
Referenced by importUsers().
ilSoapUserAdministration::__getUserMappingAsXML | ( | $a_array | ) |
return user mapping as xml
array | (user_id => login) $a_array |
Definition at line 1114 of file class.ilSoapUserAdministration.php.
References ilSoapAdministration\__raiseError().
Referenced by importUsers().
ilSoapUserAdministration::__readUserData | ( | & | $usr_obj | ) |
Definition at line 572 of file class.ilSoapUserAdministration.php.
Referenced by getUser(), and updateUser().
ilSoapUserAdministration::__setUserData | ( | & | $user_obj, |
& | $user_data | ||
) |
Definition at line 526 of file class.ilSoapUserAdministration.php.
References USER_FOLDER_ID.
Referenced by addUser(), and updateUser().
ilSoapUserAdministration::__substituteUserData | ( | $user_old, | |
$user_new | |||
) |
Definition at line 616 of file class.ilSoapUserAdministration.php.
Referenced by updateUser().
ilSoapUserAdministration::__validateUserData | ( | & | $user_data, |
$check_complete = true |
|||
) |
Definition at line 387 of file class.ilSoapUserAdministration.php.
References $ilLog, $lng, $ok, ilSoapAdministration\__appendMessage(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__setMessage(), ilAuthUtils\_getAuthMode(), ilObjUser\_loginExists(), ilObject\_lookupType(), ilAuthUtils\_needsExternalAccountByAuthMode(), ilUtil\is_email(), ilUtil\isLogin(), and ilUtil\isPassword().
Referenced by addUser(), and updateUser().
ilSoapUserAdministration::addUser | ( | $sid, | |
$user_data, | |||
$global_role_id | |||
) |
Definition at line 256 of file class.ilSoapUserAdministration.php.
References $ilLog, $ilSetting, $new_user, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), __setUserData(), __validateUserData(), IL_PASSWD_MD5, IL_PASSWD_PLAIN, ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::deleteUser | ( | $sid, | |
$user_id | |||
) |
Definition at line 341 of file class.ilSoapUserAdministration.php.
References $ilUser, $log, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::getUser | ( | $sid, | |
$user_id | |||
) |
Definition at line 151 of file class.ilSoapUserAdministration.php.
References $ilUser, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), __readUserData(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::getUserForRole | ( | $sid, | |
$role_id, | |||
$attachRoles, | |||
$active | |||
) |
Definition at line 1010 of file class.ilSoapUserAdministration.php.
References $data, $ilUser, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilPrivacySettings\_getInstance(), ilObjUser\_getUsersForRole(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().
ilSoapUserAdministration::getUserIdBySid | ( | $sid | ) |
Definition at line 1343 of file class.ilSoapUserAdministration.php.
References $data, $query, $res, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().
ilSoapUserAdministration::getUsersForContainer | ( | $sid, | |
$ref_id, | |||
$attachRoles, | |||
$active | |||
) |
return list of users following dtd users_3_7
Definition at line 932 of file class.ilSoapUserAdministration.php.
References $data, $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\_getUsersForFolder(), ilObjUser\_getUsersForGroup(), ilObjUser\_getUsersForIds(), ilObject\_lookupObjId(), ilSoapAdministration\checkObjectAccess(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\isFault(), and USER_FOLDER_ID.
ilSoapUserAdministration::getUserXML | ( | $sid, | |
$a_user_ids, | |||
$attach_roles | |||
) |
return user xmls for given user ids (csv separated ids) as xml based on usr dtd.
string | sid session id |
string | a_userids array of user ids, may be numeric or ilias ids |
boolean | attachRoles if true, role assignments will be attached, nothing will be done otherwise |
Definition at line 1267 of file class.ilSoapUserAdministration.php.
References $data, $ilUser, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\_getUserData(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::hasNewMail | ( | $sid | ) |
Definition at line 1320 of file class.ilSoapUserAdministration.php.
References $ilUser, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilMailGlobalServices\getNumberOfNewMailsByUserId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().
ilSoapUserAdministration::ilSoapUserAdministration | ( | ) |
Definition at line 37 of file class.ilSoapUserAdministration.php.
References ilSoapAdministration\ilSoapAdministration().
ilSoapUserAdministration::importUsers | ( | $sid, | |
$folder_id, | |||
$usr_xml, | |||
$conflict_rule, | |||
$send_account_mail | |||
) |
define ("IL_FAIL_ON_CONFLICT", 1); define ("IL_UPDATE_ON_CONFLICT", 2); define ("IL_IGNORE_ON_CONFLICT", 3);
Definition at line 631 of file class.ilSoapUserAdministration.php.
References $ilLog, $ilUser, $lng, ilSoapAdministration\__checkSession(), ilUtil\__extractId(), __getImportProtocolAsXML(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), __getUserMappingAsXML(), ilSoapAdministration\__raiseError(), ilObjRole\_getAssignUsersStatus(), ilObject\_lookupTitle(), DOMXML_LOAD_VALIDATING, domxml_open_mem(), ilObjectFactory\getInstanceByRefId(), IL_EXTRACT_ROLES, IL_FAIL_ON_CONFLICT, IL_IGNORE_ON_CONFLICT, IL_IMPORT_FAILURE, IL_IMPORT_SUCCESS, IL_IMPORT_WARNING, IL_UPDATE_ON_CONFLICT, IL_USER_IMPORT, IL_USER_MAPPING_ID, IL_VERIFY, ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), isPermittedRole(), and USER_FOLDER_ID.
|
protected |
check if assignment is allowed
protected
@return |
Definition at line 834 of file class.ilSoapUserAdministration.php.
References $ilLog, $ilUser, $location, ilObjRole\_getAssignUsersStatus(), and USER_FOLDER_ID.
Referenced by importUsers().
ilSoapUserAdministration::login | ( | $client, | |
$username, | |||
$password | |||
) |
Definition at line 44 of file class.ilSoapUserAdministration.php.
References $_COOKIE, $_POST, $client, $ilUser, ilSoapAdministration\__raiseError(), and ilUtil\setCookie().
Referenced by loginLDAP().
ilSoapUserAdministration::loginCAS | ( | $client, | |
$PT, | |||
$username | |||
) |
Definition at line 71 of file class.ilSoapUserAdministration.php.
References $client, ilSoapAdministration\__initAuthenticationObject(), ilSoapAdministration\__raiseError(), and AUTH_CAS.
ilSoapUserAdministration::loginLDAP | ( | $client, | |
$username, | |||
$password | |||
) |
ilSoapUserAdministration::logout | ( | $sid | ) |
Definition at line 97 of file class.ilSoapUserAdministration.php.
References ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().
ilSoapUserAdministration::lookupUser | ( | $sid, | |
$user_name | |||
) |
Definition at line 122 of file class.ilSoapUserAdministration.php.
References $ilUser, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\getUserIdByLogin(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::searchUser | ( | $sid, | |
$a_keyfields, | |||
$query_operator, | |||
$a_keyvalues, | |||
$attach_roles, | |||
$active | |||
) |
return user xml following dtd 3.7
String | $sid | session id |
String | array $a_keyfields array of user fieldname, following dtd 3.7 | |
String | $queryOperator | any logical operator |
String | array $a_keyValues values separated by space, at least 3 chars per search term |
Definition at line 1154 of file class.ilSoapUserAdministration.php.
References $data, $query, $row, __buildSearchQuery(), ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::updatePassword | ( | $sid, | |
$user_id, | |||
$new_password | |||
) |
Definition at line 229 of file class.ilSoapUserAdministration.php.
References ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.
ilSoapUserAdministration::updateUser | ( | $sid, | |
$user_data | |||
) |
Definition at line 178 of file class.ilSoapUserAdministration.php.
References $ilUser, $log, ilSoapAdministration\__checkSession(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), __readUserData(), __setUserData(), __substituteUserData(), __validateUserData(), ilObjectFactory\getInstanceByObjId(), IL_PASSWD_MD5, IL_PASSWD_PLAIN, ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.