IliasModule Class Reference

Public Member Functions
	__construct ($module_id, $module_data, $ilias_index, $ilias_version)
	getId ()
	getIndex ()
	getModuleType ()
	getModuleTypeName ()
	setTitle ($module_title)
	getTitle ()
	setDescription ($module_description)
	getDescription ()
	getMakeDate ()
	getChangeDate ()
	getPath ()
	getRoute ($action= '')
	isAllowed ($action= '')
	setAuthorIlias ($module_author)
	getAuthorIlias ()
	getAuthorStudip ()
	setConnection ($seminar_id)
	unsetConnection ($seminar_id)
	setConnectionType ($is_connected)
	isConnected ()
	getReferenceString ()
	getIcon ($mode= 'inactive')

Data Fields
	$id
	$title
	$description
	$module_type
	$module_type_name
	$author
	$make_date
	$change_date
	$path
	$ilias_index
	$allowed_operations
	$is_offline
	$is_connected
	$owner
	$author_studip
	$siblings_count
	$icon_file

Constructor & Destructor Documentation

__construct	(		$module_id,
			$module_data,
			$ilias_index,
			$ilias_version
	)

constructor

init class public

Parameters

string	$module_id	module-id
string	$module_type	module-type
string	$ilias_index	ilias installation index

Member Function Documentation

getAuthorIlias

(

)

get ILIAS author ID

returns author public

Returns

string author id

getAuthorStudip

(

)

get author Stud.IP-User

returns author User object public

Returns

object User

getChangeDate

(

)

get change date

returns change date public

Returns

string change date

getDescription

(

)

get description

returns description public

Returns

string description

getIcon

(

$mode = 'inactive'

)

get icon-image

returns icon-image public

Returns

string icon-image

getId

(

)

get id

returns id public

Returns

string id

getIndex

(

)

get ILIAS installation index

returns ILIAS installation index public

Returns

string cms-type

getMakeDate

(

)

get make date

returns make date public

Returns

string make date

getModuleType

(

)

get module-type

returns module-type public

Returns

string module-type

getModuleTypeName

(

)

get module-type name

returns module-type name public

Returns

string module-type name

getPath

(

)

get ILIAS path

returns ILIAS path public

Returns

string ILIAS path

getReferenceString

(

)

get reference string

returns reference string for content-module public

Returns

string reference string

getRoute

(

$action = ''

)

get route

returns route for given action public

Parameters

string

action start, edit, view_tools, view_course, add, remove

Returns

string url

getTitle

(

)

get title

returns title public

Returns

string title

isAllowed

(

$action = ''

)

get permission status

returns true if given action is allowed public

Parameters

string

action start, edit

Returns

boolean permission status

isConnected

(

)

get connection-status

returns true, if module is connected to seminar public

Returns

boolean connection-status

setAuthorIlias

(

$module_author

)

set ILIAS author ID

sets author public

Parameters

array

$module_authors

authors

setConnection

(

$seminar_id

)

set connection

sets connection with seminar public

Parameters

string

$seminar_id

seminar-id

Returns

boolean successful

setConnectionType

(

$is_connected

)

set connection-status

sets connection-status public

Parameters

boolean

$is_connected

connection-status

setDescription

(

$module_description

)

set description

sets description public

Parameters

string

$module_description

description

setTitle

(

$module_title

)

set title

sets title public

Parameters

string

$module_title

title

unsetConnection

(

$seminar_id

)

unset connection

unsets connection with seminar public

Parameters

string

$seminar_id

seminar-id

Returns

boolean successful

Field Documentation

$allowed_operations

$author

$author_studip

$change_date

$description

$icon_file

$id

$ilias_index

$is_connected

$is_offline

$make_date

$module_type

$module_type_name

$owner

$path

$siblings_count

$title

---

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

• lib/ilias_interface/IliasModule.class.php