ConnectedCMS Class Reference

Inheritance diagram for ConnectedCMS:

Public Member Functions
	__construct ($cms="")
	init ($cms)
	initSubclasses ()
	getConnectionStatus ($cms="")
	getPreferences ()
	setContentModule ($data, $is_connected=false)
	newContentModule ($module_id, $module_type, $is_connected=false)
	getName ()
	getCMSType ()
	getAbsolutePath ()
	getTargetFile ()
	getClassPrefix ()
	isAuthNecessary ()
	getUserPrefix ()
	getLogo ()
	getUserContentModules ()
	searchContentModules ($key)
	terminate ()
	deleteConnectedModules ($object_id)

Data Fields
	$title
	$is_active
	$cms_type
	$name = null
	$ABSOLUTE_PATH_ELEARNINGMODULES = null
	$ABSOLUTE_PATH_SOAP = null
	$RELATIVE_PATH_DB_CLASSES = false
	$CLASS_PREFIX = null
	$auth_necessary = null
	$USER_AUTO_CREATE = null
	$USER_PREFIX = null
	$target_file = null
	$logo_file = null
	$db_classes
	$soap_data = null
	$soap_client
	$types = null
	$roles = null
	$db
	$db_class
	$link
	$user
	$permissions
	$content_module

Constructor & Destructor Documentation

__construct

(

$cms = ""

)

constructor

init class. don't call directly but by extending class ("new Ilias3ConnectedCMS($cms)" for example), except for basic administration

Parameters

string

$cms

system-type

Member Function Documentation

deleteConnectedModules

(

$object_id

)

getAbsolutePath

(

)

get path of cms

returns path of cms public

Returns

string path

getClassPrefix

(

)

get class prefix

returns class prefix public

Returns

string class prefix

getCMSType

(

)

get type of cms

returns type of cms public

Returns

string type

getConnectionStatus

(

$cms = ""

)

get connection status

checks settings public

Parameters

string

$cms

system-type

Returns

array messages

getLogo

(

)

get logo-image

returns logo-image public

Returns

string logo-image

getName

(

)

get name of cms

returns name of cms public

Returns

string name

getPreferences

(

)

get preferences

shows additional settings. can be overwritten by subclass. public

getTargetFile

(

)

get target file of cms

returns target file of cms public

Returns

string target file

getUserContentModules

(

)

get user modules

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

Returns

boolean returns false

getUserPrefix

(

)

get active-setting

returns true, if cms is active public

Returns

boolean active-setting function isActive($cms = "") { return $this->is_active; } get user prefix

returns user prefix public

Returns

string user prefix

init

(

$cms

)

init settings

gets settings from config-array and initializes db private

Parameters

string

$cms

system-type

initSubclasses

(

)

init subclasses

loads classes for user-functions public

isAuthNecessary

(

)

get authentification-setting

returns true, if authentification is necessary public

Returns

boolean authentification-setting

newContentModule	(		$module_id,
			$module_type,
			$is_connected = false
	)

create new instance of subclass content-module

creates new instance of subclass content-module public

Parameters

string	$module_id	module-id
string	$module_type	module-type
boolean	$is_connected	is module connected to seminar?

searchContentModules

(

$key

)

search modules

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

Returns

boolean returns false

setContentModule	(		$data,
			$is_connected = false
	)

create new instance of subclass content-module with given values

creates new instance of subclass content-module with given values public

Parameters

array	$data	module-data
boolean	$is_connected	is module connected to seminar?

terminate

(

)

dummy-method. can be overwritten by subclass.

Field Documentation

$ABSOLUTE_PATH_ELEARNINGMODULES = null

$ABSOLUTE_PATH_SOAP = null

$auth_necessary = null

$CLASS_PREFIX = null

$cms_type

$content_module

$db

$db_class

$db_classes

$is_active

$link

$logo_file = null

$name = null

$permissions

$RELATIVE_PATH_DB_CLASSES = false

$roles = null

$soap_client

$soap_data = null

$target_file = null

$title

$types = null

$user

$USER_AUTO_CREATE = null

$USER_PREFIX = null

---

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

• lib/elearning/ConnectedCMS.class.php