Stud.IP  5.4
ConnectedCMS Class Reference
Inheritance diagram for ConnectedCMS:
Ilias3ConnectedCMS LonCapaConnectedCMS PmWikiConnectedCMS Ilias4ConnectedCMS Ilias5ConnectedCMS

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()

__construct (   $cms = "")

constructor

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

Parameters
string$cmssystem-type

Member Function Documentation

◆ deleteConnectedModules()

deleteConnectedModules (   $object_id)

◆ getAbsolutePath()

getAbsolutePath ( )

get path of cms

returns path of cms public

Returns
string path

◆ getClassPrefix()

getClassPrefix ( )

get class prefix

returns class prefix public

Returns
string class prefix

◆ getCMSType()

getCMSType ( )

get type of cms

returns type of cms public

Returns
string type

◆ getConnectionStatus()

getConnectionStatus (   $cms = "")

get connection status

checks settings public

Parameters
string$cmssystem-type
Returns
array messages

◆ getLogo()

getLogo ( )

get logo-image

returns logo-image public

Returns
string logo-image

◆ getName()

getName ( )

get name of cms

returns name of cms public

Returns
string name

◆ getPreferences()

getPreferences ( )

get preferences

shows additional settings. can be overwritten by subclass. public

◆ getTargetFile()

getTargetFile ( )

get target file of cms

returns target file of cms public

Returns
string target file

◆ getUserContentModules()

getUserContentModules ( )

get user modules

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

Returns
boolean returns false

◆ getUserPrefix()

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()

init (   $cms)

init settings

gets settings from config-array and initializes db private

Parameters
string$cmssystem-type

◆ initSubclasses()

initSubclasses ( )

init subclasses

loads classes for user-functions public

◆ isAuthNecessary()

isAuthNecessary ( )

get authentification-setting

returns true, if authentification is necessary public

Returns
boolean authentification-setting

◆ newContentModule()

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_idmodule-id
string$module_typemodule-type
boolean$is_connectedis module connected to seminar?

◆ searchContentModules()

searchContentModules (   $key)

search modules

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

Returns
boolean returns false

◆ setContentModule()

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$datamodule-data
boolean$is_connectedis module connected to seminar?

◆ terminate()

terminate ( )

dummy-method. can be overwritten by subclass.

Field Documentation

◆ $ABSOLUTE_PATH_ELEARNINGMODULES

◆ $ABSOLUTE_PATH_SOAP

$ABSOLUTE_PATH_SOAP = null

◆ $auth_necessary

$auth_necessary = null

◆ $CLASS_PREFIX

$CLASS_PREFIX = null

◆ $cms_type

$cms_type

◆ $content_module

$content_module

◆ $db

$db

◆ $db_class

$db_class

◆ $db_classes

$db_classes

◆ $is_active

$is_active

◆ $link

$link

◆ $logo_file

$logo_file = null

◆ $name

$name = null

◆ $permissions

$permissions

◆ $RELATIVE_PATH_DB_CLASSES

$RELATIVE_PATH_DB_CLASSES = false

◆ $roles

$roles = null

◆ $soap_client

$soap_client

◆ $soap_data

$soap_data = null

◆ $target_file

$target_file = null

◆ $title

$title

◆ $types

$types = null

◆ $user

$user

◆ $USER_AUTO_CREATE

$USER_AUTO_CREATE = null

◆ $USER_PREFIX

$USER_PREFIX = null

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