Abstract parent class for all StudyProgrammeTypeHook plugin classes. More...

Inheritance diagram for ilStudyProgrammeTypeHookPlugin:

Collaboration diagram for ilStudyProgrammeTypeHookPlugin:

Public Member Functions
	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	allowSetTitle ($a_type_id, $a_lang_code, $a_title)
	The following methods can be overridden by plugins. More...

	allowSetDescription ($a_type_id, $a_lang_code, $a_description)
	Return false if setting a description is not allowed. More...

	allowSetDefaultLanguage ($a_type_id, $a_lang_code)
	Return false if setting a default language is not allowed. More...

	allowDelete ($a_type_id)
	Return false if StudyProgramme type cannot be deleted. More...

	allowUpdate ($a_type_id)
	Return false if StudyProgramme type is locked and no updates are possible. More...

	allowAssignAdvancedMDRecord ($a_type_id, $a_record_id)
	Return false if an AdvancedMDRecord cannot be assigned to an StudyProgramme type. More...

	allowDeassignAdvancedMDRecord ($a_type_id, $a_record_id)
	Return false if an AdvancedMDRecord cannot be deassigned from an StudyProgramme type. More...

Public Member Functions inherited from ilPlugin
	__construct ()

	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	getPluginName ()
	Get Plugin Name. More...

	getId ()
	Get Id. More...

	getLastUpdateVersion ()
	Get Version of last update. More...

	getVersion ()
	Get Current Version (from plugin.php file). More...

	getIliasMinVersion ()
	Get Required ILIAS min. More...

	getIliasMaxVersion ()
	Get Required ILIAS max. More...

	getActive ()
	Get Active. More...

	setDBVersion ($a_dbversion)
	Set DB Version. More...

	getDBVersion ()
	Get DB Version. More...

	writeDBVersion ($a_dbversion)
	Write DB version to database. More...

	getDirectory ()
	Get Plugin Directory. More...

	includeClass ($a_class_file_name)
	Include (once) a class file. More...

	getPrefix ()
	Get plugin prefix, used for lang vars. More...

	getTablePrefix ()
	Get db table plugin prefix. More...

	updateLanguages ($a_lang_keys=null)

	updateDatabase ()
	Update database. More...

	loadLanguageModule ()
	Load language module for plugin. More...

	txt ($a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate ($a_template, $a_par1=true, $a_par2=true)
	Get template from plugin. More...

	getImagePath ($a_img)
	Get image path. More...

	getStyleSheetLocation ($a_css_file)
	Get css file location. More...

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable. More...

	isActive ()
	Check whether plugin is active. More...

	needsUpdate ()
	Check whether update is needed. More...

	install ()
	Install. More...

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. More...

Protected Member Functions
	slotInit ()
	Object initialization done by slot. More...

Protected Member Functions inherited from ilPlugin
	setSlotObject ($a_slot)
	Set Plugin Slot. More...

	getSlotObject ()
	Get Plugin Slot. More...

	getClassesDirectory ()
	Get Plugin's classes Directory. More...

	getLanguageDirectory ()
	Get Plugin's language Directory. More...

	slotInit ()
	Object initialization done by slot. More...

	init ()
	Object initialization. More...

	afterInstall ()
	After install processing. More...

	beforeActivation ()
	Before activation processing. More...

	afterActivation ()
	After activation processing. More...

	afterDeactivation ()
	After deactivation processing. More...

	beforeUninstall ()

	afterUninstall ()

	readEventListening ()
	Read the event listening definitions from the plugin.xml (if file exists) More...

	clearEventListening ()
	Clear the entries of this plugin in the event handling table. More...

	beforeUpdate ()
	Before update processing. More...

	afterUpdate ()
	After update processing. More...

Additional Inherited Members
Static Public Member Functions inherited from ilPlugin
static	_getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin directory. More...

static	getAvailableLangFiles ($a_lang_directory)
	Get array of all language files in the plugin. More...

static	hasConfigureClass ($a_slot_dir, $a_name)
	Has the plugin a configure class? More...

static	getConfigureClassName ($a_name)
	Get plugin configure class name. More...

static	getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
	Get DB update script filename (full path) More...

static	lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
	Lookup language text. More...

static	langExitsById ($pluginId, $langVar)
	Is searched lang var available in plugin lang files. More...

static	_getImagePath ( $a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
	Get image path. More...

static	createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)

static	getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get record from il_plugin table. More...

static	getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin object. More...

static	lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Lookup information data in il_plugin. More...

static	getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get all active plugin names for a slot. More...

static	getActivePluginIdsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get All active plugin ids for a slot. More...

static	lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
	Lookup name for id. More...

static	lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
	Lookup id for name. More...

Protected Attributes inherited from ilPlugin
	$lang_initialised = false

	$id = ''

Detailed Description

Abstract parent class for all StudyProgrammeTypeHook plugin classes.

Author: Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id$

Definition at line 13 of file class.ilStudyProgrammeTypeHookPlugin.php.

Member Function Documentation

◆ allowAssignAdvancedMDRecord()

ilStudyProgrammeTypeHookPlugin::allowAssignAdvancedMDRecord	(	$a_type_id,
		$a_record_id
	)

Return false if an AdvancedMDRecord cannot be assigned to an StudyProgramme type.

Parameters

int	$a_type_id
int	$a_record_id

Returns: bool

Definition at line 136 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ allowDeassignAdvancedMDRecord()

ilStudyProgrammeTypeHookPlugin::allowDeassignAdvancedMDRecord	(	$a_type_id,
		$a_record_id
	)

Return false if an AdvancedMDRecord cannot be deassigned from an StudyProgramme type.

Parameters

int	$a_type_id
int	$a_record_id

Returns: bool

Definition at line 148 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ allowDelete()

ilStudyProgrammeTypeHookPlugin::allowDelete ( $a_type_id )

Return false if StudyProgramme type cannot be deleted.

Parameters

int $a_type_id

Returns: bool

Definition at line 113 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ allowSetDefaultLanguage()

ilStudyProgrammeTypeHookPlugin::allowSetDefaultLanguage	(	$a_type_id,
		$a_lang_code
	)

Return false if setting a default language is not allowed.

Parameters

int	$a_type_id
string	$a_lang_code

Returns: bool

Definition at line 102 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ allowSetDescription()

ilStudyProgrammeTypeHookPlugin::allowSetDescription	(	$a_type_id,
		$a_lang_code,
		$a_description
	)

Return false if setting a description is not allowed.

Parameters

int	$a_type_id
string	$a_lang_code
string	$a_description

Returns: bool

Definition at line 90 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ allowSetTitle()

ilStudyProgrammeTypeHookPlugin::allowSetTitle	(	$a_type_id,
		$a_lang_code,
		$a_title
	)

The following methods can be overridden by plugins.

Return false if setting a title is not allowed

Parameters

int	$a_type_id
string	$a_lang_code
string	$a_title

Returns: bool

Definition at line 77 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ allowUpdate()

ilStudyProgrammeTypeHookPlugin::allowUpdate ( $a_type_id )

Return false if StudyProgramme type is locked and no updates are possible.

Parameters

int $a_type_id

Returns: bool

Definition at line 124 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return true;
     }

◆ getComponentName()

ilStudyProgrammeTypeHookPlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name

Definition at line 30 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return 'StudyProgramme';
     }

◆ getComponentType()

ilStudyProgrammeTypeHookPlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Definition at line 20 of file class.ilStudyProgrammeTypeHookPlugin.php.

References IL_COMP_MODULE.

     {
         return IL_COMP_MODULE;
     }

◆ getSlot()

ilStudyProgrammeTypeHookPlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Definition at line 40 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return 'StudyProgrammeTypeHook';
     }

◆ getSlotId()

ilStudyProgrammeTypeHookPlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id

Definition at line 50 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         return 'prgtypehk';
     }

◆ slotInit()

ilStudyProgrammeTypeHookPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Definition at line 58 of file class.ilStudyProgrammeTypeHookPlugin.php.

     {
         // nothing to do here
     }

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

Modules/StudyProgramme/classes/types/class.ilStudyProgrammeTypeHookPlugin.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ allowAssignAdvancedMDRecord()

◆ allowDeassignAdvancedMDRecord()

◆ allowDelete()

◆ allowSetDefaultLanguage()

◆ allowSetDescription()

◆ allowSetTitle()

◆ allowUpdate()

◆ getComponentName()

◆ getComponentType()

◆ getSlot()

◆ getSlotId()

◆ slotInit()