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

Inheritance diagram for ilOrgUnitTypeHookPlugin:

Collaboration diagram for ilOrgUnitTypeHookPlugin:

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 OrgUnit type cannot be deleted. More...

	allowUpdate ($a_type_id)
	Return false if OrgUnit 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 OrgUnit type. More...

	allowDeassignAdvancedMDRecord ($a_type_id, $a_record_id)
	Return false if an AdvancedMDRecord cannot be deassigned from an OrgUnit 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 ()

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

	getVersion ()

	getIliasMinVersion ()

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

	getActive ()

	setDBVersion (int $a_dbversion)

	getDBVersion ()

	writeDBVersion (int $a_dbversion)

	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 (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	gets a ilTemplate instance of a html-file in the plugin /templates More...

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

	getStyleSheetLocation (string $a_css_file)

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

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. More...

	promoteGlobalScreenProvider ()

	getGlobalScreenProviderCollection ()

	exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic)
	This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More...

	exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic)
	This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More...

	getMessage ()

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

Protected Member Functions inherited from ilPlugin
	setSlotObject (ilPluginSlot $a_slot)

	getSlotObject ()

	getClassesDirectory ()

	getLanguageDirectory ()

	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 ()
	This is Plugin-Specific and is triggered after the uninstall command of a plugin. More...

	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 (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
	Get plugin directory. More...

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

static	hasConfigureClass (string $a_slot_dir, array $plugin_data, array $plugin_db_data)
	Has the plugin a configure class? More...

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

static	getDBUpdateScriptName (string $a_ctype, string $a_cname, string $a_slot_name, string $a_pname)

static	lookupTxt (string $a_mod_prefix, string $a_pl_id, string $a_lang_var)

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

static	_getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img)

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

static	getPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	getPluginObject (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

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

static	getActivePluginsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)

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

static	lookupNameForId (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_id)

static	lookupIdForName (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_name)

static	lookupTypeInformationsForId (string $id)

Protected Attributes inherited from ilPlugin
	$slot

	$active = false

	$iliasmaxversion = ""

	$iliasminversion = ""

	$version = ""

	$lastupdateversion = ""

	$dbversion = 0

	$lang_initialised = false

	$id = ''

	$provider_collection

	$message

Detailed Description

Abstract parent class for all OrgUnitTypeHook plugin classes.

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

Version: $Id$

Definition at line 11 of file class.ilOrgUnitTypeHookPlugin.php.

Member Function Documentation

◆ allowAssignAdvancedMDRecord()

ilOrgUnitTypeHookPlugin::allowAssignAdvancedMDRecord	(	$a_type_id,
		$a_record_id
	)

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

Parameters

int	$a_type_id
int	$a_record_id

Returns: bool

Definition at line 149 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ allowDeassignAdvancedMDRecord()

ilOrgUnitTypeHookPlugin::allowDeassignAdvancedMDRecord	(	$a_type_id,
		$a_record_id
	)

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

Parameters

int	$a_type_id
int	$a_record_id

Returns: bool

Definition at line 163 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ allowDelete()

ilOrgUnitTypeHookPlugin::allowDelete ( $a_type_id )

Return false if OrgUnit type cannot be deleted.

Parameters

int $a_type_id

Returns: bool

Definition at line 122 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ allowSetDefaultLanguage()

ilOrgUnitTypeHookPlugin::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 109 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ allowSetDescription()

ilOrgUnitTypeHookPlugin::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 95 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ allowSetTitle()

ilOrgUnitTypeHookPlugin::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 80 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ allowUpdate()

ilOrgUnitTypeHookPlugin::allowUpdate ( $a_type_id )

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

Parameters

int $a_type_id

Returns: bool

Definition at line 135 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return true;
     }

◆ getComponentName()

ilOrgUnitTypeHookPlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name

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

     {
         return 'OrgUnit';
     }

◆ getComponentType()

ilOrgUnitTypeHookPlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Definition at line 19 of file class.ilOrgUnitTypeHookPlugin.php.

References IL_COMP_MODULE.

     {
         return IL_COMP_MODULE;
     }

◆ getSlot()

ilOrgUnitTypeHookPlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Definition at line 41 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return 'OrgUnitTypeHook';
     }

◆ getSlotId()

ilOrgUnitTypeHookPlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id

Definition at line 52 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         return 'orgutypehk';
     }

◆ slotInit()

ilOrgUnitTypeHookPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Definition at line 61 of file class.ilOrgUnitTypeHookPlugin.php.

     {
         // nothing to do here
     }

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

Modules/OrgUnit/classes/Types/class.ilOrgUnitTypeHookPlugin.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()