ContentModule Class Reference

Inheritance diagram for ContentModule:

Collaboration diagram for ContentModule:

Public Member Functions
	ContentModule ($module_id="", $module_type, $cms_type)
	setId ($module_id)
	getId ()
	setCMSType ($module_cms_type)
	getCMSType ()
	getCMSName ()
	setModuleType ($module_type)
	getModuleType ()
	getModuleTypeName ()
	setTitle ($module_title)
	getTitle ()
	setDescription ($module_description)
	getDescription ()
	setAuthors ($module_authors)
	getAuthors ()
	setConnection ($seminar_id)
	unsetConnection ($seminar_id)
	setConnectionType ($is_connected)
	isConnected ()
	getReferenceString ()
	getIcon ()
	isDummy ()
	createDummyForErrormessage ($error="unknown")
	isAllowed ($operation)

Data Fields
	$id
	$title
	$module_type
	$module_type_name
	$icon_file
	$cms_type
	$cms_name
	$description
	$authors
	$is_connected
	$is_dummy
	$allowed_operations
	$db_class
	$view

Member Function Documentation

ContentModule()

ContentModule	(		$module_id = "",
			$module_type,
			$cms_type
	)

constructor

init class. don't call directly, class is loaded by ConnectedCMS. @access public

Parameters

string	$module_id	module-id
string	$module_type	module-type
string	$cms_type	system-type

Here is the call graph for this function:

createDummyForErrormessage()

createDummyForErrormessage

(

$error = "unknown"

)

create module-dummy

sets title and description of module to display error-message @access public

Parameters

string

$error

error-type

Here is the call graph for this function:

Here is the caller graph for this function:

getAuthors()

getAuthors

(

)

get authors

returns authors @access public

Returns

array authors

getCMSName()

getCMSName

(

)

get cms name

returns cms name @access public

Returns

string cms name

Here is the caller graph for this function:

getCMSType()

getCMSType

(

)

get cms-type

returns cms-type @access public

Returns

string cms-type

getDescription()

getDescription

(

)

get description

returns description @access public

Returns

string description

getIcon()

getIcon

(

)

get icon-image

returns icon-image @access public

Returns

string icon-image

Here is the call graph for this function:

getId()

getId

(

)

get id

returns id @access public

Returns

string id

Here is the caller graph for this function:

getModuleType()

getModuleType

(

)

get module-type

returns module-type @access public

Returns

string module-type

getModuleTypeName()

getModuleTypeName

(

)

get module-type name

returns module-type name @access public

Returns

string module-type name

getReferenceString()

getReferenceString

(

)

get reference string

returns reference string for content-module @access public

Returns

string reference string

getTitle()

getTitle

(

)

get title

returns title @access public

Returns

string title

isAllowed()

isAllowed

(

$operation

)

ask for permission for given operation

dummy-method. returns false. must be overwritten by subclass. @access public

Parameters

string

$operation

operation

Returns

boolean returns false

Reimplemented in Ilias3ContentModule, and PmWikiContentModule.

isConnected()

isConnected

(

)

get connection-status

returns true, if module is connected to seminar @access public

Returns

boolean connection-status

isDummy()

isDummy

(

)

get module-status

returns true, if module is a dummy @access public

Returns

boolean module-status

Here is the caller graph for this function:

setAuthors()

setAuthors

(

$module_authors

)

set authors

sets authors @access public

Parameters

array

$module_authors

authors

Here is the caller graph for this function:

setCMSType()

setCMSType

(

$module_cms_type

)

set cms-type

sets cms-type @access public

Parameters

string

$module_cms_type

cms-type

Here is the caller graph for this function:

setConnection()

setConnection

(

$seminar_id

)

set connection

sets connection with seminar @access public

Parameters

string

$seminar_id

seminar-id

Returns

boolean successful

Reimplemented in Ilias3ContentModule, and Ilias4ContentModule.

Here is the call graph for this function:

Here is the caller graph for this function:

setConnectionType()

setConnectionType

(

$is_connected

)

set connection-status

sets connection-status @access public

Parameters

boolean

$is_connected

connection-status

setDescription()

setDescription

(

$module_description

)

set description

sets description @access public

Parameters

string

$module_description

description

Here is the caller graph for this function:

setId()

setId

(

$module_id

)

set id

sets id @access public

Parameters

string

$module_id

id

Here is the caller graph for this function:

setModuleType()

setModuleType

(

$module_type

)

set module-type

sets module-type @access public

Parameters

string

$module_type

module-type

Here is the caller graph for this function:

setTitle()

setTitle

(

$module_title

)

set title

sets title @access public

Parameters

string

$module_title

title

Here is the caller graph for this function:

unsetConnection()

unsetConnection

(

$seminar_id

)

unset connection

unsets connection with seminar @access public

Parameters

string

$seminar_id

seminar-id

Returns

boolean successful

Reimplemented in Ilias3ContentModule.

Here is the call graph for this function:

Field Documentation

$allowed_operations

$allowed_operations

$authors

$authors

$cms_name

$cms_name

$cms_type

$cms_type

$db_class

$db_class

$description

$description

$icon_file

$icon_file

$id

$id

$is_connected

$is_connected

$is_dummy

$is_dummy

$module_type

$module_type

$module_type_name

$module_type_name

$title

$title

$view

$view

---

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

• lib/elearning/ContentModule.class.php