Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
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)
 

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

constructor

ILIAS connection main class

Parameters
string$indexilias installation index

Member Function Documentation

addCourse (   $studip_course_id)

create course

creates new ilias course public

Parameters
string$studip_course_idseminar-id
Returns
string|false|null
addCourseModule (   $module_id,
  $module_data 
)

add course module

adds module instance to list of course modules public

checkUser ( )

check user

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

Returns
boolean returns user status
checkUserCoursePermissions (   $ilias_course_id = "")

check user permissions

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

Parameters
string$ilias_course_idcourse-id
Returns
boolean returns false on error
deleteConnectedModules (   $object_id)
deleteCourse (   $course)

delete given course

deletes ILIAS course data public

Parameters
$courseStud.IP course object
Returns
boolean returns false
deleteUser (   $user)

delete given user account

deletes ILIAS user data public

Parameters
$userStud.IP user object
Returns
boolean returns false
getAbsolutePath ( )

get url of ILIAS installation

returns url of ILIAS installation public

Returns
string path
getAllowedModuleTypes ( )

get active module types

returns all active module types for current ILIAS installation public

getChilds (   $parent_id)

Helper function to fetch childs including objects in folders

public

Parameters
string$parent_id
Returns
array result
getClientId ( )

get client-id

returns client-id public

Returns
string client-id
getConnectionSettingsStatus ( )

get connection status

checks connection settings public

Returns
string messages
getContentSettingsStatus ( )

get content status

checks content settings public

Returns
string messages
getCourseModules ( )

get course modules

returns all added course module instances public

getError ( )

get errors

returns array of error strings. public

Returns
array of error strings
static getExistingIndices ( )
static

get existing ilias indices

loads existing indices of all ilias installations from database public

static getIliasInfo (   $url)
static

get ILIAS info

checks ILIAS base settings public

Parameters
string$url
Returns
array info
getIndex ( )

get index of ILIAS installation

returns index of ILIAS installation public

Returns
string type
static getIntVersion (   $version)
static

get ILIAS version as int

converts ILIAS version to int value public

Returns
string messages
getModule (   $module_id)

get module

returns module instance by ID public

Parameters
string$module_idILIAS ref id
Returns
instance of IliasModule
getName ( )

get name of ILIAS installation

returns name of cms public

Returns
string name
getOperation (   $operation)

get operation

returns id for given operation-string public

Parameters
string$operationoperation
Returns
integer operation-id
getOperationArray (   $operation)

get operation-ids

returns an array of operation-ids public

Parameters
string$operationoperation
Returns
array operation-ids
getPath (   $ref_id)

get ILIAS path

returns full path for given ILIAS ref ID public

Parameters
$ref_idILIAS reference id
Returns
string path
getPermissionsSettingsStatus ( )

get permissions status

checks permissions settings public

Returns
string messages
getSoapMethods ( )

get soap methods

returns array of available soap methods public

Returns
array soap method names
getStructure (   $ref_id)

get structure

returns structure for given ILIAS lm ID public

Parameters
$ref_idILIAS reference id
Returns
string path
static getsupportedModuleTypes ( )
static

get supported module types

returns all active module types for current ILIAS installation public

getTargetFile ( )

get target file of ILIAS installation

returns target file of ILIAS installation public

Returns
string target file
getUserFullname (   $user_id)

get ILIAS user full name

returns full name of given ILIAS user ID public

Parameters
$user_idILIAS user id
Returns
string full name
getUserModules ( )

get user modules

returns content modules from current users private category public

Returns
array list of content modules
getUserModuleViewPermission (   $module_id)

get user permissions for ILIAS module

returns allowed operations for current user and given module public

Parameters
string$module_idmodule-id
Returns
boolean returns false on error
getUserPrefix ( )

get user prefix

returns user prefix public

Returns
string user prefix
isActive ( )

get active-setting

returns true, if ILIAS installation is active public

Returns
boolean active-setting
isAllowedModuleType (   $module_type)

check is module type is allowed

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

loadSettings ( )

load ILIAS settings from config table

newUser ( )

create new user-account

creates new ILIAS user account public

Returns
boolean returns false
newUserCategory ( )

create new user category

creates new ILIAS user account public

Returns
boolean returns false
searchModules (   $search_key)

search ILIAS modules

performs search for ILIAS modules public

Returns
boolean returns false
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_idstudip range id
string$module_idILIAS ref id
string$module_typetype of ILIAS module
string$connection_modecopy or reference
string$write_permission_levelwrite permission for new module requires this perm (autor, tutor, dozent, never)
Returns
boolean successful
storeSettings ( )

store settings

stores current ILIAS settings to config table. public

unsetCourseModuleConnection (   $studip_course_id,
  $module_id,
  $module_type 
)

unset module connection

unsets ILIAS module connection with course public

Parameters
string$studip_course_idstudip range id
string$module_idILIAS ref id
string$module_typetype of ILIAS module
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_idcourse-id
Returns
boolean successful
updateUser (   $user)

update given user account

updates ILIAS user data public

Parameters
$userStud.IP user object
Returns
boolean returns false

Field Documentation

$allowed_operations
$course_modules
$crs_roles
$error
$global_roles
$ilias_config
$ilias_int_version
$ilias_interface_config
$operations
$soap_client
$tree_allowed_operations
$user
$user_modules
$user_operations
const CRS_ADMIN_ROLE = '1'
const CRS_MEMBER_ROLE = '2'
const CRS_NO_NOTIFICATION = '2'
const CRS_NOTIFICATION = '1'
const CRS_PASSED_VALUE = '0'
const CRS_TUTOR_ROLE = '3'
const OPERATION_COPY = 'copy'
const OPERATION_DELETE = 'delete'
const OPERATION_EDIT_LEARNING_PROGRESS = 'edit_learning_progress'
const OPERATION_EDIT_SUBMISSION_GRADES = 'edit_submissions_grades'
const OPERATION_READ = 'read'
const OPERATION_READ_LEARNING_PROGRESS = 'read_learning_progress'
const OPERATION_VIEW_TEST_RESULTS = 'tst_results'
const OPERATION_VIEW_TEST_STATISTICS = 'tst_statistics'
const OPERATION_VISIBLE = 'visible'
const OPERATION_WRITE = 'write'

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