Inheritance diagram for Ilias3Soap:

Public Member Functions
	__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

	$caching_active = false

Data Fields inherited from StudipSoapClient
	$soap_client

	$error

	$faultstring

Constructor & Destructor Documentation

__construct ( $cms )

constructor

init class.

Parameters

string $cms system-type

Member Function Documentation

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

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	(	$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	(	$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	(	$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	(	$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	(	$user_data,
		$role_id
	)

add user

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

call	(	$method,
		$params
	)

call soap-function

calls soap-function with given parameters public

Parameters

string	method method-name
string	params parameters

Returns: mixed result

checkReferenceById ( $id )

check reference by title

gets reference-id by object-title public

Parameters

string	key keyword
string	type object-type

Returns: string reference-id

clearCache ( )

clear cache

clears cache public

deleteObject ( $reference_id )

delete object

deletes ilias-object public

Parameters

string ref_id reference-id

Returns: boolean result

deleteUser ( $user_id )

delete user

deletes user-account public

Parameters

string user_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

string	user_id user-id
string	role_id role-id

Returns: boolean result

getCachingStatus ( )

get caching status

gets caching-status public

Returns: boolean status

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

getLocalRoles ( $course_id )

get local roles

gets local roles for given object public

Parameters

string course_id object-id

Returns: array role-objects

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

get object by reference

gets object by reference-id public

Parameters

ref	reference_id
string	user_id ilias-user-id

Returns: array object

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

get object by title

gets object by title public

Parameters

string	key keyword
string	type object-type

Returns: array object

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

get operation

gets all ilias operations public

Returns: array operations

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

getSID ( )

get sid

returns soap-session-id public

Returns: string session-id

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

get user

gets user-data for given user-id public

Parameters

string user_id user-id

Returns: array user-data

getUserRoles ( $user_id )

get user roles

gets user roles public

Parameters

string user_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

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

Returns: boolean result

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

load cache

load soap-cache public

Parameters

string cms cms-type

login ( )

login

login to soap-webservice 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

string username username

Returns: string user-id

ParseXML ( $data )

parse xml

use xml-parser public

Parameters

string data xml-data

Returns: array object

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

save cache

saves soap-cache in session-variable public

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

setCachingStatus ( $bool_value )

set caching status

sets caching-status public

Parameters

boolean bool_value status

setUserType ( $user_type )

set usertype

sets usertype fpr soap-calls public

Parameters

string user_type usertype (admin or user)

updatePassword	(	$user_id,
		$password
	)

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

updateUser ( $user_data )

update user

update user-data public

Parameters

array user_data user-data

Returns: string result

Field Documentation

$admin_sid

$caching_active = false

$cms_type

$soap_cache

$user_sid

$user_type

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

lib/elearning/Ilias3Soap.class.php

Public Member Functions

Data Fields

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation