Stud.IP  5.4
Ilias4Soap Class Reference
Inheritance diagram for Ilias4Soap:
Ilias3Soap StudipSoapClient Ilias5Soap

Public Member Functions

 __construct ($cms)
 
 addUser ($user_data, $role_id)
 
 copyObject ($source_id, $target_id)
 
 getPath ($ref_id)
 
 getRawPath ($ref_id)
 
- Public Member Functions inherited from Ilias3Soap
 __construct ($cms)
 
 setUserType ($user_type)
 
 getSID ()
 
 call ($method, $params)
 
 loadCacheData ($cms)
 
 getCachingStatus ()
 
 setCachingStatus ($bool_value)
 
 clearCache ()
 
 saveCacheData ()
 
 ParseXML ($data)
 
 login ()
 
 logout ()
 
 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)
 
 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)
 
 addUser ($user_data, $role_id)
 
 updateUser ($user_data)
 
 updatePassword ($user_id, $password)
 
 deleteUser ($user_id)
 
 isMember ($user_id, $course_id)
 
 addMember ($user_id, $type, $course_id)
 
 addCourse ($course_data, $ref_id)
 
 getCourseXML ($course_data)
 
 checkReferenceById ($id)
 
- Public Member Functions inherited from StudipSoapClient
 __construct ($path)
 
 _call ($method, $params)
 
 getError ()
 
 __construct ($path)
 
 _call ($method, $params)
 
 getError ()
 

Data Fields

 $cms_type
 
 $admin_sid
 
 $user_sid
 
 $user_type
 
 $soap_cache
 
 $separator_string
 
- Data Fields inherited from Ilias3Soap
 $cms_type
 
 $admin_sid
 
 $user_sid
 
 $user_type
 
 $soap_cache
 
 $caching_active = false
 
- Data Fields inherited from StudipSoapClient
 $soap_client
 
 $error
 
 $faultstring
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $cms)

constructor

init class.

Parameters
string$cmssystem-type

Member Function Documentation

◆ addUser()

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

◆ copyObject()

copyObject (   $source_id,
  $target_id 
)

copy object

copy ilias-object public

Parameters
stringsource_id reference-id
stringtarget_id reference-id
Returns
string result

◆ getPath()

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()

getRawPath (   $ref_id)

returns repository-path to ilias-object

public

Parameters
stringsource_id reference-id
stringtarget_id reference-id
Returns
string result

Field Documentation

◆ $admin_sid

$admin_sid

◆ $cms_type

$cms_type

◆ $separator_string

$separator_string

◆ $soap_cache

$soap_cache

◆ $user_sid

$user_sid

◆ $user_type

$user_type

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