Stud.IP: ConnectedIlias Class Reference

Public Member Functions
	__construct ($index)

	loadSettings ()

	storeSettings ()

	getSoapMethods ()

	getConnectionSettingsStatus ()

	getContentSettingsStatus ()

	getPermissionsSettingsStatus ()

	newUser ()

	updateUser ($user)

	deleteUser ($user)

	deleteCourse ($course)

	newUserCategory ()

	getUserFullname ($user_id)

	getPath ($ref_id)

	getStructure ($ref_id)

	getAllowedModuleTypes ()

	isAllowedModuleType ($module_type)

	getUserModules ()

	getModule ($module_id)

	getChilds ($parent_id)

	updateCourseConnections ($course_id)

	setCourseModuleConnection ($studip_course_id, $module_id, $module_type, $connection_mode, $write_permission_level)

	unsetCourseModuleConnection ($studip_course_id, $module_id, $module_type)

	addCourseModule ($module_id, $module_data)

	getCourseModules ()

	addCourse ($studip_course_id)

	checkUser ()

	checkUserCoursePermissions ($ilias_course_id="")

	getUserModuleViewPermission ($module_id)

	getOperation ($operation)

	getOperationArray ($operation)

	getName ()

	getIndex ()

	getAbsolutePath ()

	getTargetFile ()

	isActive ()

	getClientId ()

	getUserPrefix ()

	getError ()

	searchModules ($search_key)

	deleteConnectedModules ($object_id)

	getConnectedUser (string $ilias_user_id)

Static Public Member Functions
static	getIntVersion ($version)

static	getIliasInfo ($url)

static	getsupportedModuleTypes ()

static	getExistingIndices ()

Data Fields
const	CRS_NOTIFICATION = '1'

const	CRS_NO_NOTIFICATION = '2'

const	CRS_ADMIN_ROLE = '1'

const	CRS_MEMBER_ROLE = '2'

const	CRS_TUTOR_ROLE = '3'

const	CRS_PASSED_VALUE = '0'

const	OPERATION_VISIBLE = 'visible'

const	OPERATION_READ = 'read'

const	OPERATION_WRITE = 'write'

const	OPERATION_COPY = 'copy'

const	OPERATION_DELETE = 'delete'

const	OPERATION_EDIT_LEARNING_PROGRESS = 'edit_learning_progress'

const	OPERATION_VIEW_TEST_STATISTICS = 'tst_statistics'

const	OPERATION_READ_LEARNING_PROGRESS = 'read_learning_progress'

const	OPERATION_EDIT_SUBMISSION_GRADES = 'edit_submissions_grades'

const	OPERATION_VIEW_TEST_RESULTS = 'tst_results'

	$index

	$ilias_config

	$ilias_interface_config

	$ilias_int_version

	$global_roles

	$crs_roles

	$error

	$soap_client

	$course_modules

	$user

	$user_modules

	$operations

	$user_operations

	$allowed_operations

	$tree_allowed_operations

Constructor & Destructor Documentation

◆ __construct()

__construct ( $index )

constructor

ILIAS connection main class

Parameters

string $index ilias installation index

Member Function Documentation

◆ addCourse()

addCourse ( $studip_course_id )

create course

creates new ilias course public

Parameters

string $studip_course_id seminar-id

Returns: string|false|null

◆ addCourseModule()

addCourseModule	(	$module_id,
		$module_data
	)

add course module

adds module instance to list of course modules public

◆ checkUser()

checkUser ( )

check user

checks if ILIAS user exists, creates new user if not public

Returns: boolean returns user status

◆ checkUserCoursePermissions()

checkUserCoursePermissions ( $ilias_course_id = "" )

check user permissions

checks user permissions for connected course and changes setting if necessary public

Parameters

string $ilias_course_id course-id

Returns: boolean returns false on error

◆ deleteConnectedModules()

deleteConnectedModules ( $object_id )

◆ deleteCourse()

deleteCourse ( $course )

delete given course

deletes ILIAS course data public

Parameters

$course Stud.IP course object

Returns: boolean returns false

◆ deleteUser()

deleteUser ( $user )

delete given user account

deletes ILIAS user data public

Parameters

$user Stud.IP user object

Returns: boolean returns false

◆ getAbsolutePath()

getAbsolutePath ( )

get url of ILIAS installation

returns url of ILIAS installation public

Returns: string path

◆ getAllowedModuleTypes()

getAllowedModuleTypes ( )

get active module types

returns all active module types for current ILIAS installation public

◆ getChilds()

getChilds ( $parent_id )

Helper function to fetch children including objects in folders The typo in the function name, 'childs', is intentional to reflect the name of the ILIAS-SOAP call.

public

Parameters

string $parent_id

Returns: array result

◆ getClientId()

getClientId ( )

get client-id

returns client-id public

Returns: string client-id

◆ getConnectedUser()

getConnectedUser ( string $ilias_user_id )

Parameters

string $ilias_user_id

Returns: IliasUser|void

◆ getConnectionSettingsStatus()

getConnectionSettingsStatus ( )

get connection status

checks connection settings public

Returns: string messages

◆ getContentSettingsStatus()

getContentSettingsStatus ( )

get content status

checks content settings public

Returns: string messages

◆ getCourseModules()

getCourseModules ( )

get course modules

returns all added course module instances public

◆ getError()

getError ( )

get errors

returns array of error strings. public

Returns: array of error strings

◆ getExistingIndices()

static getExistingIndices ( )

static

get existing ilias indices

loads existing indices of all ilias installations from database public

◆ getIliasInfo()

static getIliasInfo ( $url )

static

get ILIAS info

checks ILIAS base settings public

Parameters

string $url

Returns: array info

◆ getIndex()

getIndex ( )

get index of ILIAS installation

returns index of ILIAS installation public

Returns: string type

◆ getIntVersion()

static getIntVersion ( $version )

static

get ILIAS version as int

converts ILIAS version to int value public

Returns: string messages

◆ getModule()

getModule ( $module_id )

get module

returns module instance by ID public

Parameters

string $module_id ILIAS ref id

Returns: instance of IliasModule

◆ getName()

getName ( )

get name of ILIAS installation

returns name of cms public

Returns: string name

◆ getOperation()

getOperation ( $operation )

get operation

returns id for given operation-string public

Parameters

string $operation operation

Returns: integer operation-id

◆ getOperationArray()

getOperationArray ( $operation )

get operation-ids

returns an array of operation-ids public

Parameters

string $operation operation

Returns: array operation-ids

◆ getPath()

getPath ( $ref_id )

get ILIAS path

returns full path for given ILIAS ref ID public

Parameters

$ref_id ILIAS reference id

Returns: string path

◆ getPermissionsSettingsStatus()

getPermissionsSettingsStatus ( )

get permissions status

checks permissions settings public

Returns: string messages

◆ getSoapMethods()

getSoapMethods ( )

get soap methods

returns array of available soap methods public

Returns: array soap method names

◆ getStructure()

getStructure ( $ref_id )

get structure

returns structure for given ILIAS lm ID public

Parameters

$ref_id ILIAS reference id

Returns: string path

◆ getsupportedModuleTypes()

static getsupportedModuleTypes ( )

static

get supported module types

returns all active module types for current ILIAS installation public

◆ getTargetFile()

getTargetFile ( )

get target file of ILIAS installation

returns target file of ILIAS installation public

Returns: string target file

◆ getUserFullname()

getUserFullname ( $user_id )

get ILIAS user full name

returns full name of given ILIAS user ID public

Parameters

$user_id ILIAS user id

Returns: string full name

◆ getUserModules()

getUserModules ( )

get user modules

returns content modules from current users private category public

Returns: array list of content modules

◆ getUserModuleViewPermission()

getUserModuleViewPermission ( $module_id )

get user permissions for ILIAS module

returns allowed operations for current user and given module public

Parameters

string $module_id module-id

Returns: boolean returns false on error

◆ getUserPrefix()

getUserPrefix ( )

get user prefix

returns user prefix public

Returns: string user prefix

◆ isActive()

isActive ( )

get active-setting

returns true, if ILIAS installation is active public

Returns: boolean active-setting

◆ isAllowedModuleType()

isAllowedModuleType ( $module_type )

check is module type is allowed

returns true if module type is allowed for current ILIAS installation public

◆ loadSettings()

loadSettings ( )

load ILIAS settings from config table

◆ newUser()

newUser ( )

create new user-account

creates new ILIAS user account public

Returns: boolean returns false

◆ newUserCategory()

newUserCategory ( )

create new user category

creates new ILIAS user account public

Returns: boolean returns false

◆ searchModules()

searchModules ( $search_key )

search ILIAS modules

performs search for ILIAS modules public

Returns: boolean returns false

◆ setCourseModuleConnection()

setCourseModuleConnection	(	$studip_course_id,
		$module_id,
		$module_type,
		$connection_mode,
		$write_permission_level
	)

set module connection

sets module connection to course public

Parameters

string	$studip_course_id	studip range id
string	$module_id	ILIAS ref id
string	$module_type	type of ILIAS module
string	$connection_mode	copy or reference
string	$write_permission_level	write permission for new module requires this perm (autor, tutor, dozent, never)

Returns: boolean successful

◆ storeSettings()

storeSettings ( )

store settings

stores current ILIAS settings to config table. public

◆ unsetCourseModuleConnection()

unsetCourseModuleConnection	(	$studip_course_id,
		$module_id,
		$module_type
	)

unset module connection

unsets ILIAS module connection with course public

Parameters

string	$studip_course_id	studip range id
string	$module_id	ILIAS ref id
string	$module_type	type of ILIAS module

◆ updateCourseConnections()

updateCourseConnections ( $course_id )

check connected modules and update connections

checks if there are modules in the course that are not connected to the seminar public

Parameters

string $course_id course-id

Returns: boolean successful

◆ updateUser()

updateUser ( $user )

update given user account

updates ILIAS user data public

Parameters

$user Stud.IP user object

Returns: boolean returns false

Field Documentation

◆ $allowed_operations

$allowed_operations

◆ $course_modules

$course_modules

◆ $crs_roles

$crs_roles

◆ $error

$error

◆ $global_roles

$global_roles

◆ $ilias_config

$ilias_config

◆ $ilias_int_version

$ilias_int_version

◆ $ilias_interface_config

$ilias_interface_config

◆ $index

$index

◆ $operations

$operations

◆ $soap_client

$soap_client

◆ $tree_allowed_operations

$tree_allowed_operations

◆ $user

$user

◆ $user_modules

$user_modules

◆ $user_operations

$user_operations

◆ CRS_ADMIN_ROLE

const CRS_ADMIN_ROLE = '1'

◆ CRS_MEMBER_ROLE

const CRS_MEMBER_ROLE = '2'

◆ CRS_NO_NOTIFICATION

const CRS_NO_NOTIFICATION = '2'

◆ CRS_NOTIFICATION

const CRS_NOTIFICATION = '1'

◆ CRS_PASSED_VALUE

const CRS_PASSED_VALUE = '0'

◆ CRS_TUTOR_ROLE

const CRS_TUTOR_ROLE = '3'

◆ OPERATION_COPY

const OPERATION_COPY = 'copy'

◆ OPERATION_DELETE

const OPERATION_DELETE = 'delete'

◆ OPERATION_EDIT_LEARNING_PROGRESS

const OPERATION_EDIT_LEARNING_PROGRESS = 'edit_learning_progress'

◆ OPERATION_EDIT_SUBMISSION_GRADES

const OPERATION_EDIT_SUBMISSION_GRADES = 'edit_submissions_grades'

◆ OPERATION_READ

const OPERATION_READ = 'read'

◆ OPERATION_READ_LEARNING_PROGRESS

const OPERATION_READ_LEARNING_PROGRESS = 'read_learning_progress'

◆ OPERATION_VIEW_TEST_RESULTS

const OPERATION_VIEW_TEST_RESULTS = 'tst_results'

◆ OPERATION_VIEW_TEST_STATISTICS

const OPERATION_VIEW_TEST_STATISTICS = 'tst_statistics'

◆ OPERATION_VISIBLE

const OPERATION_VISIBLE = 'visible'

◆ OPERATION_WRITE

const OPERATION_WRITE = 'write'

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

lib/ilias_interface/ConnectedIlias.php

Public Member Functions

Static Public Member Functions

Data Fields

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCourse()

◆ addCourseModule()

◆ checkUser()

◆ checkUserCoursePermissions()

◆ deleteConnectedModules()

◆ deleteCourse()

◆ deleteUser()

◆ getAbsolutePath()

◆ getAllowedModuleTypes()

◆ getChilds()

◆ getClientId()

◆ getConnectedUser()

◆ getConnectionSettingsStatus()

◆ getContentSettingsStatus()

◆ getCourseModules()

◆ getError()

◆ getExistingIndices()

◆ getIliasInfo()

◆ getIndex()

◆ getIntVersion()

◆ getModule()

◆ getName()

◆ getOperation()

◆ getOperationArray()

◆ getPath()

◆ getPermissionsSettingsStatus()

◆ getSoapMethods()

◆ getStructure()

◆ getsupportedModuleTypes()

◆ getTargetFile()

◆ getUserFullname()

◆ getUserModules()

◆ getUserModuleViewPermission()

◆ getUserPrefix()

◆ isActive()

◆ isAllowedModuleType()

◆ loadSettings()

◆ newUser()

◆ newUserCategory()

◆ searchModules()

◆ setCourseModuleConnection()

◆ storeSettings()

◆ unsetCourseModuleConnection()

◆ updateCourseConnections()

◆ updateUser()

Field Documentation

◆ $allowed_operations

◆ $course_modules

◆ $crs_roles

◆ $error

◆ $global_roles

◆ $ilias_config

◆ $ilias_int_version

◆ $ilias_interface_config

◆ $index

◆ $operations

◆ $soap_client

◆ $tree_allowed_operations

◆ $user

◆ $user_modules

◆ $user_operations

◆ CRS_ADMIN_ROLE

◆ CRS_MEMBER_ROLE

◆ CRS_NO_NOTIFICATION

◆ CRS_NOTIFICATION

◆ CRS_PASSED_VALUE

◆ CRS_TUTOR_ROLE

◆ OPERATION_COPY

◆ OPERATION_DELETE

◆ OPERATION_EDIT_LEARNING_PROGRESS

◆ OPERATION_EDIT_SUBMISSION_GRADES

◆ OPERATION_READ

◆ OPERATION_READ_LEARNING_PROGRESS

◆ OPERATION_VIEW_TEST_RESULTS