Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
IliasSoap Class Reference
Inheritance diagram for IliasSoap:
StudipSoapClient

Public Member Functions

 __construct ($index, $soap_path, $ilias_client= '', $ilias_version= '', $admin_login= '', $admin_password= '')
 
 setUserType ($user_type)
 
 getSID ()
 
 call ($method, $params)
 
 loadCacheData ()
 
 getCachingStatus ()
 
 setCachingStatus ($bool_value)
 
 clearCache ()
 
 saveCacheData ()
 
 ParseXML ($data)
 
 loginAdmin ()
 
 loginUser ($username, $password)
 
 logout ()
 
 checkPassword ($username, $password)
 
 parseIliasObject ($xml, $condition_field= '', $condition_value= '')
 
 searchObjects ($types, $key, $combination, $user_id="")
 
 getObjectByReference ($ref, $user_id="")
 
 getObjectByTitle ($key, $type="")
 
 getReferenceByTitle ($key, $type="")
 
 addObject ($object_data, $ref_id)
 
 deleteObject ($reference_id)
 
 addReference ($object_id, $ref_id)
 
 addDesktopItems ($user_id, $ref_ids)
 
 getTreeChilds ($ref_id, $types="", $user_id="")
 
 getOperations ()
 
 getObjectTreeOperations ($ref_id, $user_id)
 
 getUserRoles ($user_id)
 
 getLocalRoles ($course_id)
 
 addRole ($role_data, $ref_id)
 
 addRoleFromTemplate ($role_data, $ref_id, $role_id)
 
 deleteUserRoleEntry ($user_id, $role_id)
 
 addUserRoleEntry ($user_id, $role_id)
 
 grantPermissions ($operations, $role_id, $ref_id)
 
 revokePermissions ($role_id, $ref_id)
 
 lookupUser ($username)
 
 getUser ($user_id)
 
 getUserFullname ($user_id)
 
 searchUser ($user_id)
 
 addUser ($user_data, $role_id)
 
 copyObject ($source_id, $target_id)
 
 getStructure ($ref_id)
 
 getPath ($ref_id)
 
 getRawPath ($ref_id)
 
 getInstallationInfoXML ()
 
 deleteUser ($user_id)
 
 isMember ($user_id, $course_id)
 
 addMember ($user_id, $type, $course_id)
 
 addCourse ($course_data, $ref_id)
 
 addGroup ($group_data, $ref_id)
 
 updateGroup ($group_data, $ref_id)
 
 assignGroupMember ($group_id, $user_id, $type="Member")
 
 excludeGroupMember ($group_id, $user_id)
 
 getGroup ($group_id)
 
 getCourseXML ($course_data)
 
 getGroupXML ($group_data)
 
 getCoursesForUser ($user_id, $status=1)
 
 checkReferenceById ($id)
 
- Public Member Functions inherited from StudipSoapClient
 __construct ($path)
 
 _call ($method, $params)
 
 getError ()
 
 __construct ($path)
 
 _call ($method, $params)
 
 getError ()
 

Additional Inherited Members

- Data Fields inherited from StudipSoapClient
 $soap_client
 
 $error
 
 $faultstring
 

Constructor & Destructor Documentation

__construct (   $index,
  $soap_path,
  $ilias_client = '',
  $ilias_version = '',
  $admin_login = '',
  $admin_password = '' 
)

constructor

init class. public

Parameters
string$indexILIAS installation index
string$soap_pathSOAP url
string$ilias_clientILIAS client
string$ilias_versionILIAS int client
string$admin_loginILIAS admin account login
string$admin_passwordILIAS admin account password

Member Function Documentation

addCourse (   $course_data,
  $ref_id 
)

add course

adds course public

Parameters
arraycourse_data course-data
stringref_id target-id
Returns
string course-id
addDesktopItems (   $user_id,
  $ref_ids 
)

add references to desktop

adds references to personal desktop public

Parameters
stringobject_id source-object-id
stringref_id target-id
Returns
string created reference-id
addGroup (   $group_data,
  $ref_id 
)

add group

adds group public

Parameters
arraygroup_data group data
stringref_id target id
Returns
string group id
addMember (   $user_id,
  $type,
  $course_id 
)

add course member

adds user to course public

Parameters
stringuser_id user-id
stringtype member-type (Admin, Tutor or Member)
stringcourse_id course-id
Returns
boolean result
addObject (   $object_data,
  $ref_id 
)

add object

adds new ilias-object public

Parameters
arrayobject_data object-data
stringref_id reference-id
Returns
string result
addReference (   $object_id,
  $ref_id 
)

add reference

add a new reference to an existing ilias-object public

Parameters
stringobject_id source-object-id
stringref_id target-id
Returns
string created reference-id
addRole (   $role_data,
  $ref_id 
)

add role

adds a new role public

Parameters
arrayrole_data data for role-object
stringref_id reference-id
Returns
string role-id
addRoleFromTemplate (   $role_data,
  $ref_id,
  $role_id 
)

add role from tremplate

adds a new role and adopts properties of the given role template public

Parameters
arrayrole_data data for role-object
stringref_id reference-id
stringrole_id role-template-id
Returns
string role-id
addUser (   $user_data,
  $role_id 
)

add user by importUsers

adds new user and sets role-id public

Parameters
arrayuser_data user-data
stringrole_id global role-id for new user
Returns
string user-id
addUserRoleEntry (   $user_id,
  $role_id 
)

add user role entry

adds a role entry for the given user public

Parameters
stringuser_id user-id
stringrole_id role-id
Returns
boolean result
assignGroupMember (   $group_id,
  $user_id,
  $type = "Member" 
)

assign group member

assigns user to group public

Parameters
stringgroup_id group id
stringuser_id user id
stringtype type
call (   $method,
  $params 
)

call soap-function

calls soap-function with given parameters public

Parameters
stringmethod method-name
stringparams parameters
Returns
mixed result
checkPassword (   $username,
  $password 
)

Check Auth

login to soap-webservice public

Returns
string result
checkReferenceById (   $id)

check reference by title

gets reference id by object id public

Parameters
stringkey keyword
stringtype object-type
Returns
string reference-id
clearCache ( )

clear cache

clears cache public

copyObject (   $source_id,
  $target_id 
)

copy object

copy ilias-object public

Parameters
stringsource_id reference-id
stringtarget_id reference-id
Returns
string result
deleteObject (   $reference_id)

delete object

deletes ilias-object public

Parameters
stringref_id reference-id
Returns
boolean result
deleteUser (   $user_id)

update user

update user-data public

Parameters
arrayuser_data user-data
Returns
string result update password

update password with given string and write it uncrypted to the ilias-database public

Parameters
stringuser_id user-id
stringpassword password
Returns
string result delete user

deletes user-account public

Parameters
stringuser_id user-id
Returns
string result
deleteUserRoleEntry (   $user_id,
  $role_id 
)

delete user role entry

deletes a role entry from the given user public

Parameters
stringuser_id user-id
stringrole_id role-id
Returns
boolean result
excludeGroupMember (   $group_id,
  $user_id 
)

exclude group member

removes user from group public

Parameters
stringgroup_id group id
stringuser_id user id
getCachingStatus ( )

get caching status

gets caching-status public

Returns
boolean status
getCoursesForUser (   $user_id,
  $status = 1 
)

get courses for given user

gets course xml-object for given course-data public

Parameters
arraycourse_data course-data
Returns
string course-xml
getCourseXML (   $course_data)

get course-xml

gets course xml-object for given course-data public

Parameters
arraycourse_data course-data
Returns
string course-xml
getGroup (   $group_id)

get group

returns group xml public

Parameters
stringgroup_id group id
Returns
string group xml
getGroupXML (   $group_data)

get group xml

gets group xml object for given group data public

Parameters
arraygroup_data group data
Returns
string group xml
getInstallationInfoXML ( )

returns ILIAS-Server-Info

public

Returns
string result
getLocalRoles (   $course_id)

get local roles

gets local roles for given object public

Parameters
stringcourse_id object-id
Returns
array role-objects
getObjectByReference (   $ref,
  $user_id = "" 
)

get object by reference

gets object by reference-id public

Parameters
refreference_id
stringuser_id ilias-user-id
Returns
array object
getObjectByTitle (   $key,
  $type = "" 
)

get object by title

gets object by title public

Parameters
stringkey keyword
stringtype object-type
Returns
array object
getObjectTreeOperations (   $ref_id,
  $user_id 
)

get object tree operations

gets permissions for object at given tree-node public

Parameters
stringref_id reference-id
stringuser_id user-id for permissions
Returns
array operation-ids
getOperations ( )

get operation

gets all ilias operations public

Returns
array operations
getPath (   $ref_id)

get path

returns repository-path to ilias-object public

Parameters
stringsource_id reference-id
stringtarget_id reference-id
Returns
string result
getRawPath (   $ref_id)

returns repository-path to ilias-object

public

Parameters
stringsource_id reference-id
stringtarget_id reference-id
Returns
string result
getReferenceByTitle (   $key,
  $type = "" 
)

get reference by title

gets reference-id by object-title public

Parameters
stringkey keyword
stringtype object-type
Returns
string reference-id
getSID ( )

get sid

returns soap-session-id public

Returns
string session-id
getStructure (   $ref_id)

get structure

returns structure for ilias content object public

Parameters
stringref_id reference id
Returns
array result
getTreeChilds (   $ref_id,
  $types = "",
  $user_id = "" 
)

get tree childs

gets child-objects of the given tree node public

Parameters
stringref_id reference-id
arraytypes show only childs with these types
stringuser_id user-id for permissions
Returns
array objects
getUser (   $user_id)

get user

gets user-data for given user-id public

Parameters
stringuser_id user-id
Returns
array user-data
getUserFullname (   $user_id)

get user fullname

gets user-data for given user-id public

Parameters
stringuser_id user-id
Returns
string full name
getUserRoles (   $user_id)

get user roles

gets user roles public

Parameters
stringuser_id user-id
Returns
array role-ids
grantPermissions (   $operations,
  $role_id,
  $ref_id 
)

grant permissions

grants permissions for given operations at role-id and ref-id public

Parameters
arrayoperations operation-array
stringrole_id role-id
stringref_id reference-id
Returns
boolean result
isMember (   $user_id,
  $course_id 
)

is course member

checks if user is course-member public

Parameters
stringuser_id user-id
stringcourse_id course-id
Returns
boolean result
loadCacheData ( )

load cache

load soap-cache public

Parameters
stringcms cms-type
loginAdmin ( )

login with admin account

login to ILIAS soap webservice with admin account public

Returns
string result
loginUser (   $username,
  $password 
)

login with admin account

login to ILIAS soap webservice with current user public

Returns
string result
logout ( )

logout

logout from soap-webservice public

Returns
boolean result
lookupUser (   $username)

lookup user

gets user-id for given username public

Parameters
stringusername username
Returns
string user-id
parseIliasObject (   $xml,
  $condition_field = '',
  $condition_value = '' 
)

parse ILIAS object

parse XML and return ilias object(s) public

Parameters
stringxml xml data
stringparent_id get data for child references of parent_id
Returns
array objects
ParseXML (   $data)

parse xml

use xml-parser public

Parameters
stringdata xml-data
Returns
array object
revokePermissions (   $role_id,
  $ref_id 
)

revoke permissions

revokes all permissions role-id and ref-id public

Parameters
stringrole_id role-id
stringref_id reference-id
Returns
boolean result
saveCacheData ( )

save cache

saves soap-cache in session-variable public

searchObjects (   $types,
  $key,
  $combination,
  $user_id = "" 
)

search objects

search for ilias-objects public

Parameters
arraytypes types
stringkey keyword
stringcombination search-combination
stringuser_id ilias-user-id
Returns
array objects
searchUser (   $user_id)

search users

search for ilias users public

Parameters
arraytypes types
stringkey keyword
stringcombination search-combination
stringuser_id ilias-user-id
Returns
array objects
setCachingStatus (   $bool_value)

set caching status

sets caching-status public

Parameters
booleanbool_value status
setUserType (   $user_type)

set usertype

sets usertype for soap-calls public

Parameters
stringuser_type usertype (admin or user)
updateGroup (   $group_data,
  $ref_id 
)

update group

updates group public

Parameters
arraygroup_data group data
stringref_id group id
Returns
string result

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