Namespaces | Functions

webservice/soap/include/inc.soap_functions.php File Reference

Go to the source code of this file.

Namespaces

namespace  ilias
 

Class ilObjQuestionPool.


Functions

 login ($client, $username, $password)
 loginCAS ($client, $PT, $user)
 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)
 addCourse ($sid, $target_id, $crs_xml)
 deleteCourse ($sid, $course_id)
 assignCourseMember ($sid, $course_id, $user_id, $type)
 isAssignedToCourse ($sid, $course_id, $user_id)
 excludeCourseMember ($sid, $course_id, $user_id)
 getCourseXML ($sid, $course_id)
 updateCourse ($sid, $course_id, $xml)
 getObjIdByImportId ($sid, $import_id)
 getRefIdsByImportId ($sid, $import_id)
 getRefIdsByObjId ($sid, $object_id)
 getObjectByReference ($sid, $a_ref_id, $user_id)
 getObjectsByTitle ($sid, $a_title, $user_id)
 addObject ($sid, $a_target_id, $a_xml)
 addReference ($sid, $a_source_id, $a_target_id)
 deleteObject ($sid, $reference_id)
 removeFromSystemByImportId ($sid, $import_id)
 updateObjects ($sid, $obj_xml)
 searchObjects ($sid, $types, $key, $combination, $user_id)
 getTreeChilds ($sid, $ref_id, $types, $user_id)
 getXMLTree ($sid, $ref_id, $types, $user_id)
 getOperations ($sid)
 addUserRoleEntry ($sid, $user_id, $role_id)
 deleteUserRoleEntry ($sid, $user_id, $role_id)
 revokePermissions ($sid, $ref_id, $role_id)
 grantPermissions ($sid, $ref_id, $role_id, $permissions)
 getLocalRoles ($sid, $ref_id)
 getUserRoles ($sid, $user_id)
 deleteRole ($sid, $role_id)
 addRole ($sid, $target_id, $obj_xml)
 addRoleFromTemplate ($sid, $target_id, $obj_xml, $template_id)
 getObjectTreeOperations ($sid, $ref_id, $user_id)
 addGroup ($sid, $target_id, $group_xml)
 groupExists ($sid, $title)
 getGroup ($sid, $ref_id)
 assignGroupMember ($sid, $group_id, $user_id, $type)
 isAssignedToGroup ($sid, $group_id, $user_id)
 excludeGroupMember ($sid, $group_id, $user_id)
 sendMail ($sid, $to, $cc, $bcc, $sender, $subject, $message, $attach)
 saveQuestionResult ($sid, $user_id, $test_id, $question_id, $pass, $solution)
 saveTempFileAsMediaObject ($sid, $name, $tmp_name)
 getMobsOfObject ($sid, $a_type, $a_id)
 getStructureObjects ($sid, $ref_id)
 getRoles ($sid, $role_type, $id)
 importUsers ($sid, $folder_id, $usr_xml, $conflict_rule, $send_account_mail)
 getUsersForContainer ($sid, $ref_id, $attach_roles, $active)
 getUsersForRole ($sid, $role_id, $attach_roles, $active)
 searchUser ($sid, $a_keyfields, $query_operator, $a_keyvalues, $attach_roles, $active)
 hasNewMail ($sid)

Function Documentation

addCourse ( sid,
target_id,
crs_xml 
)

Definition at line 119 of file inc.soap_functions.php.

References $target_id.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->addCourse($sid,$target_id,$crs_xml);
}

addGroup ( sid,
target_id,
group_xml 
)

Definition at line 395 of file inc.soap_functions.php.

References $target_id.

{
        include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';

        $soa =& new ilSoapGroupAdministration();

        return $soa->addGroup($sid,$target_id,$group_xml);
}

addObject ( sid,
a_target_id,
a_xml 
)

Definition at line 222 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->addObject($sid,$a_target_id,$a_xml);
}

addReference ( sid,
a_source_id,
a_target_id 
)

Definition at line 231 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->addReference($sid,$a_source_id,$a_target_id);
}

addRole ( sid,
target_id,
obj_xml 
)

Definition at line 369 of file inc.soap_functions.php.

References $target_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->addRole($sid,$target_id,$obj_xml);
}

addRoleFromTemplate ( sid,
target_id,
obj_xml,
template_id 
)

Definition at line 377 of file inc.soap_functions.php.

References $target_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->addRoleFromTemplate($sid,$target_id,$obj_xml,$template_id);
}

addUser ( sid,
user_data,
global_role_id 
)

Definition at line 100 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->addUser($sid,$user_data,$global_role_id);
}

addUserRoleEntry ( sid,
user_id,
role_id 
)

Definition at line 306 of file inc.soap_functions.php.

References $role_id, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->addUserRoleEntry($sid,$user_id,$role_id);
}

assignCourseMember ( sid,
course_id,
user_id,
type 
)

Definition at line 135 of file inc.soap_functions.php.

References $type, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->assignCourseMember($sid,$course_id,$user_id,$type);
}

assignGroupMember ( sid,
group_id,
user_id,
type 
)

Definition at line 421 of file inc.soap_functions.php.

References $type, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';

        $sca =& new ilSoapGroupAdministration();

        return $sca->assignGroupMember($sid,$group_id,$user_id,$type);
}

deleteCourse ( sid,
course_id 
)

Definition at line 127 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->deleteCourse($sid,$course_id);
}

deleteObject ( sid,
reference_id 
)

Definition at line 240 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->deleteObject($sid,$reference_id);
}

deleteRole ( sid,
role_id 
)

Definition at line 360 of file inc.soap_functions.php.

References $role_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->deleteRole($sid,$role_id);
}

deleteUser ( sid,
user_id 
)

Definition at line 108 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->deleteUser($sid,$user_id);
}

deleteUserRoleEntry ( sid,
user_id,
role_id 
)

Definition at line 315 of file inc.soap_functions.php.

References $role_id, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->deleteUserRoleEntry($sid,$user_id,$role_id);
}

excludeCourseMember ( sid,
course_id,
user_id 
)

Definition at line 152 of file inc.soap_functions.php.

References $type, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->excludeCourseMember($sid,$course_id,$user_id,$type);
}

excludeGroupMember ( sid,
group_id,
user_id 
)

Definition at line 438 of file inc.soap_functions.php.

References $type, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';

        $sca =& new ilSoapGroupAdministration();

        return $sca->excludeGroupMember($sid,$group_id,$user_id,$type);
}

getCourseXML ( sid,
course_id 
)

Definition at line 160 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->getCourseXML($sid,$course_id);
}

getGroup ( sid,
ref_id 
)

Definition at line 412 of file inc.soap_functions.php.

References $ref_id.

{
        include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';

        $soa =& new ilSoapGroupAdministration();

        return $soa->getGroup($sid,$ref_id);
}

getLocalRoles ( sid,
ref_id 
)

Definition at line 342 of file inc.soap_functions.php.

References $ref_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->getLocalRoles($sid,$ref_id);
}

getMobsOfObject ( sid,
a_type,
a_id 
)

Definition at line 479 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUtils.php';

        $sou =& new ilSoapUtils();
        $sou->disableSOAPCheck();

        return $sou->getMobsOfObject($sid, $a_type, $a_id);
}

getObjectByReference ( sid,
a_ref_id,
user_id 
)

Definition at line 204 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getObjectByReference($sid,$a_ref_id,$user_id);
}

getObjectsByTitle ( sid,
a_title,
user_id 
)

Definition at line 213 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getObjectsByTitle($sid,$a_title,$user_id);
}

getObjectTreeOperations ( sid,
ref_id,
user_id 
)

Definition at line 386 of file inc.soap_functions.php.

References $ref_id, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->getObjectTreeOperations($sid,$ref_id,$user_id);
}

getObjIdByImportId ( sid,
import_id 
)

Definition at line 177 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getObjIdByImportId($sid,$import_id);
}

getOperations ( sid  ) 

Definition at line 296 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->getOperations($sid);
}

getRefIdsByImportId ( sid,
import_id 
)

Definition at line 186 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getRefIdsByImportId($sid,$import_id);
}

getRefIdsByObjId ( sid,
object_id 
)

Definition at line 194 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getRefIdsByObjId($sid,$object_id);
}

getRoles ( sid,
role_type,
id 
)

Definition at line 497 of file inc.soap_functions.php.

References $id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->getRoles($sid, $role_type, $id);
}

getStructureObjects ( sid,
ref_id 
)

Definition at line 489 of file inc.soap_functions.php.

References $ref_id.

                                             {
        include_once './webservice/soap/classes/class.ilSoapStructureObjectAdministration.php';

        $sca = & new ilSOAPStructureObjectAdministration();

        return $sca->getStructureObjects ($sid, $ref_id);
}

getTreeChilds ( sid,
ref_id,
types,
user_id 
)

Definition at line 275 of file inc.soap_functions.php.

References $ref_id, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getTreeChilds($sid,$ref_id,$types,$user_id);
}

getUser ( sid,
user_id 
)

Definition at line 73 of file inc.soap_functions.php.

References $user_id.

Referenced by ilCASAuth::getCASUser(), and ilCASAuth::login().

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->getUser($sid,$user_id);
}

Here is the caller graph for this function:

getUserRoles ( sid,
user_id 
)

Definition at line 351 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->getUserRoles($sid,$user_id);
}

getUsersForContainer ( sid,
ref_id,
attach_roles,
active 
)

Definition at line 515 of file inc.soap_functions.php.

References $ref_id.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->getUsersForContainer($sid, $ref_id, $attach_roles, $active);
}

getUsersForRole ( sid,
role_id,
attach_roles,
active 
)

Definition at line 524 of file inc.soap_functions.php.

References $role_id.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->getUserForRole($sid, $role_id, $attach_roles, $active);
}

getXMLTree ( sid,
ref_id,
types,
user_id 
)

Definition at line 284 of file inc.soap_functions.php.

References $ref_id, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->getXMLTree($sid,$ref_id,$types,$user_id);
}

grantPermissions ( sid,
ref_id,
role_id,
permissions 
)

Definition at line 333 of file inc.soap_functions.php.

References $permissions, $ref_id, and $role_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->grantPermissions($sid,$ref_id,$role_id,$permissions);
}

groupExists ( sid,
title 
)

Definition at line 404 of file inc.soap_functions.php.

References $title.

{
        include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';

        $soa =& new ilSoapGroupAdministration();

        return $soa->addGroup($sid,$title);
}

hasNewMail ( sid  ) 

Definition at line 543 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->hasNewMail($sid);
}

importUsers ( sid,
folder_id,
usr_xml,
conflict_rule,
send_account_mail 
)

Definition at line 506 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->importUsers($sid, $folder_id, $usr_xml, $conflict_rule, $send_account_mail);
}

isAssignedToCourse ( sid,
course_id,
user_id 
)

Definition at line 143 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->isAssignedToCourse($sid,$course_id,$user_id);
}

isAssignedToGroup ( sid,
group_id,
user_id 
)

Definition at line 429 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';

        $sca =& new ilSoapGroupAdministration();

        return $sca->isAssignedToGroup($sid,$group_id,$user_id);
}

login ( client,
username,
password 
)

Definition at line 38 of file inc.soap_functions.php.

References $client.

Referenced by ilObjiLincUser::__createLoginData(), ilObjiLincUser::__init(), ilObjiLincUser::add(), ilObjUser::hasAcceptedUserAgreement(), ilObjUser::saveAsNew(), ilObjUser::setLogin(), ilTestEvaluationUserData::setLogin(), ilObjiLincUser::update(), and ilObjUser::updateLogin().

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->login($client,$username,$password);
}

Here is the caller graph for this function:

loginCAS ( client,
PT,
user 
)

Definition at line 47 of file inc.soap_functions.php.

References $client, and $user.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->loginCAS($client, $PT, $user);
}

logout ( sid  ) 

Definition at line 56 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->logout($sid);
}

lookupUser ( sid,
user_name 
)

Definition at line 64 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->lookupUser($sid,$user_name);
}

removeFromSystemByImportId ( sid,
import_id 
)

Definition at line 249 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->removeFromSystemByImportId($sid,$import_id);
}

revokePermissions ( sid,
ref_id,
role_id 
)

Definition at line 324 of file inc.soap_functions.php.

References $ref_id, and $role_id.

{
        include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';

        $soa =& new ilSoapRBACAdministration();

        return $soa->revokePermissions($sid,$ref_id,$role_id);
}

saveQuestionResult ( sid,
user_id,
test_id,
question_id,
pass,
solution 
)

Definition at line 459 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapUtils.php';

        $sou =& new ilSoapUtils();
        $sou->disableSOAPCheck();

        return $sou->saveQuestionResult($sid,$user_id,$test_id,$question_id,$pass,$solution);
}

saveTempFileAsMediaObject ( sid,
name,
tmp_name 
)

Definition at line 469 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUtils.php';

        $sou =& new ilSoapUtils();
        $sou->disableSOAPCheck();

        return $sou->saveTempFileAsMediaObject($sid, $name, $tmp_name);
}

searchObjects ( sid,
types,
key,
combination,
user_id 
)

Definition at line 266 of file inc.soap_functions.php.

References $key, and $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->searchObjects($sid,$types,$key,$combination,$user_id);
}

searchUser ( sid,
a_keyfields,
query_operator,
a_keyvalues,
attach_roles,
active 
)

Definition at line 534 of file inc.soap_functions.php.

                                                                                                {
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->searchUser ($sid, $a_keyfields, $query_operator, $a_keyvalues, $attach_roles, $active);

}

sendMail ( sid,
to,
cc,
bcc,
sender,
subject,
message,
attach 
)

Definition at line 448 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUtils.php';

        $sou =& new ilSoapUtils();
        $sou->disableSOAPCheck();
        $sou->ignoreUserAbort();

        return $sou->sendMail($sid,$to,$cc,$bcc,$sender,$subject,$message,$attach);
}

updateCourse ( sid,
course_id,
xml 
)

Definition at line 168 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';

        $sca =& new ilSoapCourseAdministration();

        return $sca->updateCourse($sid,$course_id,$xml);
}

updateObjects ( sid,
obj_xml 
)

Definition at line 258 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';

        $soa =& new ilSoapObjectAdministration();

        return $soa->updateObjects($sid,$obj_xml);
}

updatePassword ( sid,
user_id,
new_password 
)

Definition at line 91 of file inc.soap_functions.php.

References $user_id.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->updatePassword($sid,$user_id,$new_password);
}

updateUser ( sid,
user_data 
)

Definition at line 82 of file inc.soap_functions.php.

{
        include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';

        $sua =& new ilSoapUserAdministration();

        return $sua->updateUser($sid,$user_data);
}