Stud.IP: IliasSoap Class Reference

Inheritance diagram for IliasSoap:

Public Member Functions
	__construct ($index, $soap_path, $ilias_client='', $ilias_version='', $admin_login='', $admin_password='', $http_connection_timeout=NULL, $http_request_timeout=NULL)

	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=false)

	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)

	getRoles (string $role_type, string $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)

	getCoursesForUserStatus (string $user_id, string $status)

	checkReferenceById ($id)

	getTestResults ($ref_id, $sum_only=true)

Public Member Functions inherited from StudipSoapClient
	__construct ($path, $options=['trace'=> 0])

	_call ($method, $params)

	getError ()

Data Fields
	$separator_string

Data Fields inherited from StudipSoapClient
	$soap_client

	$error

	$faultstring

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$index,
		$soap_path,
		$ilias_client = `''`,
		$ilias_version = `''`,
		$admin_login = `''`,
		$admin_password = `''`,
		$http_connection_timeout = `NULL`,
		$http_request_timeout = `NULL`
	)

constructor

init class. public

Parameters

string	$index	ILIAS installation index
string	$soap_path	SOAP url
string	$ilias_client	ILIAS client
string	$ilias_version	ILIAS int client
string	$admin_login	ILIAS admin account login
string	$admin_password	ILIAS admin account password

Member Function Documentation

◆ addCourse()

addCourse	(	$course_data,
		$ref_id
	)

add course

adds course public

Parameters

array	course_data course-data
string	ref_id target-id

Returns: string course-id

◆ addDesktopItems()

addDesktopItems	(	$user_id,
		$ref_ids
	)

add references to desktop

adds references to personal desktop public

Parameters

string	object_id source-object-id
string	ref_id target-id

Returns: string created reference-id

◆ addGroup()

addGroup	(	$group_data,
		$ref_id
	)

add group

adds group public

Parameters

array	group_data group data
string	ref_id target id

Returns: string group id

◆ addMember()

addMember	(	$user_id,
		$type,
		$course_id
	)

add course member

adds user to course public

Parameters

string	user_id user-id
string	type member-type (Admin, Tutor or Member)
string	course_id course-id

Returns: boolean result

◆ addObject()

addObject	(	$object_data,
		$ref_id
	)

add object

adds new ilias-object public

Parameters

array	object_data object-data
string	ref_id reference-id

Returns: string result

◆ addReference()

addReference	(	$object_id,
		$ref_id
	)

add reference

add a new reference to an existing ilias-object public

Parameters

string	object_id source-object-id
string	ref_id target-id

Returns: string created reference-id

◆ addRole()

addRole	(	$role_data,
		$ref_id
	)

add role

adds a new role public

Parameters

array	role_data data for role-object
string	ref_id reference-id

Returns: string role-id

◆ addRoleFromTemplate()

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

array	role_data data for role-object
string	ref_id reference-id
string	role_id role-template-id

Returns: string role-id

◆ addUser()

addUser	(	$user_data,
		$role_id
	)

add user by importUsers

adds new user and sets role-id public

Parameters

array	user_data user-data
string	role_id global role-id for new user

Returns: string user-id

◆ addUserRoleEntry()

addUserRoleEntry	(	$user_id,
		$role_id
	)

add user role entry

adds a role entry for the given user public

Parameters

string	user_id user-id
string	role_id role-id

Returns: boolean result

◆ assignGroupMember()

assignGroupMember	(	$group_id,
		$user_id,
		$type = `"Member"`
	)

assign group member

assigns user to group public

Parameters

string	group_id group id
string	user_id user id
string	type type

◆ call()

call	(	$method,
		$params
	)

call soap-function

calls soap-function with given parameters public

Parameters

string	method method-name
string	params parameters

Returns: mixed result

◆ checkPassword()

checkPassword	(	$username,
		$password
	)

Check Auth

Returns: string result

◆ checkReferenceById()

checkReferenceById ( $id )

check reference by title

gets reference id by object id public

Parameters

string	key keyword
string	type object-type

Returns: string reference-id

◆ clearCache()

clearCache ( )

clear cache

clears cache public

◆ copyObject()

copyObject	(	$source_id,
		$target_id
	)

copy object

copy ilias-object public

Parameters

string	source_id reference-id
string	target_id reference-id

Returns: string result

◆ deleteObject()

deleteObject ( $reference_id )

delete object

deletes ilias-object public

Parameters

string ref_id reference-id

Returns: boolean result

◆ deleteUser()

deleteUser ( $user_id )

update user

update user-data public

Parameters

array user_data user-data

Returns: string result update password

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

Parameters

string	user_id user-id
string	password password

Returns: string result delete user

deletes user-account public

Parameters

string $user_id user-id

Returns: string result

◆ deleteUserRoleEntry()

deleteUserRoleEntry	(	$user_id,
		$role_id
	)

delete user role entry

deletes a role entry from the given user public

Parameters

string	user_id user-id
string	role_id role-id

Returns: boolean result

◆ excludeGroupMember()

excludeGroupMember	(	$group_id,
		$user_id
	)

exclude group member

removes user from group public

Parameters

string	group_id group id
string	user_id user id

◆ getCachingStatus()

getCachingStatus ( )

get caching status

gets caching-status public

Returns: boolean status

◆ getCoursesForUser()

getCoursesForUser	(	$user_id,
		$status = `1`
	)

get courses for given user

gets course xml-object for given course-data public

Parameters

array course_data course-data

Returns: string course-xml

◆ getCoursesForUserStatus()

getCoursesForUserStatus	(	string	$user_id,
		string	$status
	)

get courses for given user by status

gets course array for given course data public

Parameters

string	$user_id	ilias user id
string	$status	MEMBER = 1, TUTOR = 2, ADMIN = 4, OWNER = 8

Returns: array course array

◆ getCourseXML()

getCourseXML ( $course_data )

get course-xml

gets course xml-object for given course-data public

Parameters

array course_data course-data

Returns: string course-xml

◆ getGroup()

getGroup ( $group_id )

get group

returns group xml public

Parameters

string group_id group id

Returns: string group xml

◆ getGroupXML()

getGroupXML ( $group_data )

get group xml

gets group xml object for given group data public

Parameters

array group_data group data

Returns: string group xml

◆ getInstallationInfoXML()

getInstallationInfoXML ( )

returns ILIAS-Server-Info

public

Returns: string result

◆ getLocalRoles()

getLocalRoles ( $course_id )

get local roles

gets local roles for given object public

Parameters

string course_id object-id

Returns: array role-objects

◆ getObjectByReference()

getObjectByReference	(	$ref,
		$user_id = `false`
	)

get object by reference

gets object by reference-id public

Parameters

ref	reference_id
string	user_id ilias-user-id

Returns: array object

◆ getObjectByTitle()

getObjectByTitle	(	$key,
		$type = `""`
	)

get object by title

gets object by title public

Parameters

string	key keyword
string	type object-type

Returns: array object

◆ getObjectTreeOperations()

getObjectTreeOperations	(	$ref_id,
		$user_id
	)

get object tree operations

gets permissions for object at given tree-node public

Parameters

string	ref_id reference-id
string	user_id user-id for permissions

Returns: array operation-ids

◆ getOperations()

getOperations ( )

get operation

gets all ilias operations public

Returns: array operations

◆ getPath()

getPath ( $ref_id )

get path

returns repository-path to ilias-object public

Parameters

string ref_id reference id

Returns: string result

◆ getRawPath()

getRawPath ( $ref_id )

returns repository-path to ilias-object

public

Parameters

string ref_id reference id

Returns: string result

◆ getReferenceByTitle()

getReferenceByTitle	(	$key,
		$type = `""`
	)

get reference by title

gets reference-id by object-title public

Parameters

string	key keyword
string	type object-type

Returns: string reference-id

◆ getRoles()

getRoles	(	string	$role_type,
		string	$id
	)

get roles

gets roles of given type for given object

Parameters

string	$role_type	type of role (global\|local\|user\|user_login\|template or empty)
string	$id	reference id, user id, or -1 for all available roles of given type

Returns: array|false role-objects

◆ getSID()

getSID ( )

get sid

returns soap-session-id public

Returns: string session-id

◆ getStructure()

getStructure ( $ref_id )

get structure

returns structure for ilias content object public

Parameters

string ref_id reference id

Returns: array result

◆ getTestResults()

getTestResults	(	$ref_id,
		$sum_only = `true`
	)

Parameters

string	$ref_id
bool	$sum_only

Returns: array|false

Exceptions

Exception

◆ getTreeChilds()

getTreeChilds	(	$ref_id,
		$types,
		$user_id
	)

get tree childs

gets child-objects of the given tree node public

Parameters

string	ref_id reference-id
array	types show only childs with these types
string	user_id user-id for permissions

Returns: array objects

◆ getUser()

getUser ( $user_id )

get user

gets user-data for given user-id public

Parameters

string $user_id user-id

Returns: array user-data

◆ getUserFullname()

getUserFullname ( $user_id )

get user fullname

gets user-data for given user-id public

Parameters

string user_id user-id

Returns: string full name

◆ getUserRoles()

getUserRoles ( $user_id )

get user roles

gets user roles public

Parameters

string user_id user-id

Returns: array role-ids

◆ grantPermissions()

grantPermissions	(	$operations,
		$role_id,
		$ref_id
	)

grant permissions

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

Parameters

array	operations operation-array
string	role_id role-id
string	ref_id reference-id

Returns: boolean result

◆ isMember()

isMember	(	$user_id,
		$course_id
	)

is course member

checks if user is course-member public

Parameters

string	user_id user-id
string	course_id course-id

Returns: boolean result

◆ loadCacheData()

loadCacheData ( )

load cache

load soap-cache public

Parameters

string cms cms-type

◆ loginAdmin()

loginAdmin ( )

Returns: string result

◆ loginUser()

loginUser	(	$username,
		$password
	)

Returns: string result

◆ logout()

logout ( )

logout

logout from soap-webservice public

Returns: boolean result

◆ lookupUser()

lookupUser ( $username )

lookup user

gets user-id for given username public

Parameters

string username username

Returns: string user-id

◆ parseIliasObject()

parseIliasObject	(	$xml,
		$condition_field = `''`,
		$condition_value = `''`
	)

parse ILIAS object

parse XML and return ilias object(s) public

Parameters

string	xml xml data
string	parent_id get data for child references of parent_id

Returns: array objects

◆ ParseXML()

ParseXML ( $data )

parse xml

use xml-parser public

Parameters

string data xml-data

Returns: array object

◆ revokePermissions()

revokePermissions	(	$role_id,
		$ref_id
	)

revoke permissions

revokes all permissions role-id and ref-id public

Parameters

string	role_id role-id
string	ref_id reference-id

Returns: boolean result

◆ saveCacheData()

saveCacheData ( )

save cache

saves soap-cache in session-variable public

◆ searchObjects()

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

search objects

search for ilias-objects public

Parameters

array	types types
string	key keyword
string	combination search-combination
string	user_id ilias-user-id

Returns: array objects

◆ searchUser()

searchUser ( $user_id )

search users

search for ilias users public

Parameters

array	types types
string	key keyword
string	combination search-combination
string	user_id ilias-user-id

Returns: array objects

◆ setCachingStatus()

setCachingStatus ( $bool_value )

set caching status

sets caching-status public

Parameters

boolean bool_value status

◆ setUserType()

setUserType ( $user_type )

set usertype

sets usertype for soap-calls public

Parameters

string user_type usertype (admin or user)

◆ updateGroup()

updateGroup	(	$group_data,
		$ref_id
	)

update group

updates group public

Parameters

array	group_data group data
string	ref_id group id

Returns: string result

Field Documentation

◆ $separator_string

$separator_string

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

lib/ilias_interface/IliasSoap.php

Public Member Functions

Data Fields

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCourse()

◆ addDesktopItems()

◆ addGroup()

◆ addMember()

◆ addObject()

◆ addReference()

◆ addRole()

◆ addRoleFromTemplate()

◆ addUser()

◆ addUserRoleEntry()

◆ assignGroupMember()

◆ call()

◆ checkPassword()

◆ checkReferenceById()

◆ clearCache()

◆ copyObject()

◆ deleteObject()

◆ deleteUser()

◆ deleteUserRoleEntry()

◆ excludeGroupMember()

◆ getCachingStatus()

◆ getCoursesForUser()

◆ getCoursesForUserStatus()

◆ getCourseXML()

◆ getGroup()

◆ getGroupXML()

◆ getInstallationInfoXML()

◆ getLocalRoles()

◆ getObjectByReference()

◆ getObjectByTitle()

◆ getObjectTreeOperations()

◆ getOperations()

◆ getPath()

◆ getRawPath()

◆ getReferenceByTitle()

◆ getRoles()

◆ getSID()

◆ getStructure()

◆ getTestResults()

◆ getTreeChilds()

◆ getUser()

◆ getUserFullname()

◆ getUserRoles()

◆ grantPermissions()

◆ isMember()

◆ loadCacheData()

◆ loginAdmin()

◆ loginUser()

◆ logout()

◆ lookupUser()

◆ parseIliasObject()

◆ ParseXML()

◆ revokePermissions()

◆ saveCacheData()

◆ searchObjects()

◆ searchUser()

◆ setCachingStatus()

◆ setUserType()

◆ updateGroup()

Field Documentation

◆ $separator_string