Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
ContentModule Class Reference
Inheritance diagram for ContentModule:
Ilias3ContentModule LonCapaContentModule PmWikiContentModule Ilias4ContentModule Ilias5ContentModule

Public Member Functions

 readData ()
 
 __construct ($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
 

Constructor & Destructor Documentation

__construct (   $module_id,
  $module_type,
  $cms_type 
)

constructor

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

Parameters
string$module_idmodule-id
string$module_typemodule-type
string$cms_typesystem-type

Member Function Documentation

createDummyForErrormessage (   $error = "unknown")

create module-dummy

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

Parameters
string$errorerror-type
getAuthors ( )

get authors

returns authors public

Returns
array authors
getCMSName ( )

get cms name

returns cms name public

Returns
string cms name
getCMSType ( )

get cms-type

returns cms-type public

Returns
string cms-type
getDescription ( )

get description

returns description public

Returns
string description
getIcon ( )

get icon-image

returns icon-image public

Returns
string icon-image
getId ( )

get id

returns id public

Returns
string id
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
getReferenceString ( )

get reference string

returns reference string for content-module public

Returns
string reference string
getTitle ( )

get title

returns title public

Returns
string title
isAllowed (   $operation)

ask for permission for given operation

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

Parameters
string$operationoperation
Returns
boolean returns false
isConnected ( )

get connection-status

returns true, if module is connected to seminar public

Returns
boolean connection-status
isDummy ( )

get module-status

returns true, if module is a dummy public

Returns
boolean module-status
readData ( )
abstract

Fetches data from conencted cms.

setAuthors (   $module_authors)

set authors

sets authors public

Parameters
array$module_authorsauthors
setCMSType (   $module_cms_type)

set cms-type

sets cms-type public

Parameters
string$module_cms_typecms-type
setConnection (   $seminar_id)

set connection

sets connection with seminar public

Parameters
string$seminar_idseminar-id
Returns
boolean successful
setConnectionType (   $is_connected)

set connection-status

sets connection-status public

Parameters
boolean$is_connectedconnection-status
setDescription (   $module_description)

set description

sets description public

Parameters
string$module_descriptiondescription
setId (   $module_id)

set id

sets id public

Parameters
string$module_idid
setModuleType (   $module_type)

set module-type

sets module-type public

Parameters
string$module_typemodule-type
setTitle (   $module_title)

set title

sets title public

Parameters
string$module_titletitle
unsetConnection (   $seminar_id)

unset connection

unsets connection with seminar public

Parameters
string$seminar_idseminar-id
Returns
boolean successful

Field Documentation

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

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