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()
| __construct | ( | $module_id, | |
| $module_type, | |||
| $cms_type | |||
| ) |
constructor
init class. don't call directly, class is loaded by ConnectedCMS. public
- Parameters
-
string $module_id module-id string $module_type module-type string $cms_type system-type
Member Function Documentation
◆ createDummyForErrormessage()
| createDummyForErrormessage | ( | $error = "unknown" | ) |
create module-dummy
sets title and description of module to display error-message public
- Parameters
-
string $error error-type
◆ getAuthors()
| getAuthors | ( | ) |
get authors
returns authors public
- Returns
- array authors
◆ getCMSName()
| getCMSName | ( | ) |
get cms name
returns cms name public
- Returns
- string cms name
◆ getCMSType()
| getCMSType | ( | ) |
get cms-type
returns cms-type public
- Returns
- string cms-type
◆ getDescription()
| getDescription | ( | ) |
get description
returns description public
- Returns
- string description
◆ getIcon()
| getIcon | ( | ) |
get icon-image
returns icon-image public
- Returns
- string icon-image
◆ getId()
| getId | ( | ) |
get id
returns id public
- Returns
- string id
◆ getModuleType()
| getModuleType | ( | ) |
get module-type
returns module-type public
- Returns
- string module-type
◆ getModuleTypeName()
| getModuleTypeName | ( | ) |
get module-type name
returns module-type name public
- Returns
- string module-type name
◆ getReferenceString()
| getReferenceString | ( | ) |
get reference string
returns reference string for content-module public
- Returns
- string reference string
◆ getTitle()
| getTitle | ( | ) |
get title
returns title public
- Returns
- string title
◆ isAllowed()
| isAllowed | ( | $operation | ) |
ask for permission for given operation
dummy-method. returns false. must be overwritten by subclass. public
- Parameters
-
string $operation operation
- Returns
- boolean returns false
◆ isConnected()
| isConnected | ( | ) |
get connection-status
returns true, if module is connected to seminar public
- Returns
- boolean connection-status
◆ isDummy()
| isDummy | ( | ) |
get module-status
returns true, if module is a dummy public
- Returns
- boolean module-status
◆ readData()
|
abstract |
Fetches data from conencted cms.
◆ setAuthors()
| setAuthors | ( | $module_authors | ) |
set authors
sets authors public
- Parameters
-
array $module_authors authors
◆ setCMSType()
| setCMSType | ( | $module_cms_type | ) |
set cms-type
sets cms-type public
- Parameters
-
string $module_cms_type cms-type
◆ setConnection()
| setConnection | ( | $seminar_id | ) |
set connection
sets connection with seminar public
- Parameters
-
string $seminar_id seminar-id
- Returns
- boolean successful
◆ setConnectionType()
| setConnectionType | ( | $is_connected | ) |
set connection-status
sets connection-status public
- Parameters
-
boolean $is_connected connection-status
◆ setDescription()
| setDescription | ( | $module_description | ) |
set description
sets description public
- Parameters
-
string $module_description description
◆ setId()
| setId | ( | $module_id | ) |
set id
sets id public
- Parameters
-
string $module_id id
◆ setModuleType()
| setModuleType | ( | $module_type | ) |
set module-type
sets module-type public
- Parameters
-
string $module_type module-type
◆ setTitle()
| setTitle | ( | $module_title | ) |
set title
sets title public
- Parameters
-
string $module_title title
◆ unsetConnection()
| unsetConnection | ( | $seminar_id | ) |
unset connection
unsets connection with seminar public
- Parameters
-
string $seminar_id seminar-id
- Returns
- boolean successful
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
