ilStudyProgrammeTypeHookPlugin Class Reference
Abstract parent class for all StudyProgrammeTypeHook plugin classes. More...
Inheritance diagram for ilStudyProgrammeTypeHookPlugin:
Collaboration diagram for ilStudyProgrammeTypeHookPlugin:
Public Member Functions | |
| allowSetTitle (int $type_id, string $lang_code, string $title) | |
| The following methods can be overridden by plugins. More... | |
| allowSetDescription (int $type_id, string $lang_code, string $description) | |
| Return false if setting a description is not allowed. More... | |
| allowSetDefaultLanguage (int $type_id, string $lang_code) | |
| Return false if setting a default language is not allowed. More... | |
| allowDelete (int $type_id) | |
| Return false if StudyProgramme type cannot be deleted. More... | |
| allowUpdate (int $type_id) | |
| Return false if StudyProgramme type is locked and no updates are possible. More... | |
| allowAssignAdvancedMDRecord (int $type_id, int $record_id) | |
| Return false if an AdvancedMDRecord cannot be assigned to an StudyProgramme type. More... | |
| allowDeassignAdvancedMDRecord (int $type_id, int $record_id) | |
| Return false if an AdvancedMDRecord cannot be deassigned from an StudyProgramme type. More... | |
| Public Member Functions inherited from ilPlugin | |
| getMessage () | |
| __construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id) | |
| getPluginName () | |
| getId () | |
| getVersion () | |
| Only very little classes seem to care about this: More... | |
| getDirectory () | |
| Only very little classes seem to care about this: More... | |
| isActive () | |
| Only very little classes seem to care about this: More... | |
| needsUpdate () | |
| install () | |
| uninstall () | |
| activate () | |
| This will update (if required) and activate the plugin. More... | |
| deactivate () | |
| update () | |
| 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) | |
| @deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| getStyleSheetLocation (string $a_css_file) | |
| @deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname) | |
| @deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ilPlugin | |
| init () | |
| Object initialization. More... | |
| getPluginInfo () | |
| getComponentInfo () | |
| getPluginSlotInfo () | |
| afterInstall () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More... | |
| beforeUninstall () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
| afterUninstall () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
| beforeActivation () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| afterActivation () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| afterDeactivation () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| updateDatabase () | |
| beforeUpdate () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More... | |
| afterUpdate () | |
| getLanguageHandler () | |
| buildLanguageHandler () | |
| Protected Attributes inherited from ilPlugin | |
| ilDBInterface | $db |
| ilComponentRepositoryWrite | $component_repository |
| string | $id |
| ilPluginLanguage | $language_handler = null |
| bool | $lang_initialised = false |
| ProviderCollection | $provider_collection |
| string | $message = '' |
Detailed Description
Abstract parent class for all StudyProgrammeTypeHook plugin classes.
- Version
- $Id$
Definition at line 29 of file class.ilStudyProgrammeTypeHookPlugin.php.
Member Function Documentation
◆ allowAssignAdvancedMDRecord()
| ilStudyProgrammeTypeHookPlugin::allowAssignAdvancedMDRecord | ( | int | $type_id, |
| int | $record_id | ||
| ) |
Return false if an AdvancedMDRecord cannot be assigned to an StudyProgramme type.
Definition at line 78 of file class.ilStudyProgrammeTypeHookPlugin.php.
78 : bool
79 {
80 return true;
81 }
◆ allowDeassignAdvancedMDRecord()
| ilStudyProgrammeTypeHookPlugin::allowDeassignAdvancedMDRecord | ( | int | $type_id, |
| int | $record_id | ||
| ) |
Return false if an AdvancedMDRecord cannot be deassigned from an StudyProgramme type.
Definition at line 86 of file class.ilStudyProgrammeTypeHookPlugin.php.
86 : bool
87 {
88 return true;
89 }
◆ allowDelete()
| ilStudyProgrammeTypeHookPlugin::allowDelete | ( | int | $type_id | ) |
Return false if StudyProgramme type cannot be deleted.
Definition at line 62 of file class.ilStudyProgrammeTypeHookPlugin.php.
62 : bool
63 {
64 return true;
65 }
◆ allowSetDefaultLanguage()
| ilStudyProgrammeTypeHookPlugin::allowSetDefaultLanguage | ( | int | $type_id, |
| string | $lang_code | ||
| ) |
Return false if setting a default language is not allowed.
Definition at line 54 of file class.ilStudyProgrammeTypeHookPlugin.php.
54 : bool
55 {
56 return true;
57 }
◆ allowSetDescription()
| ilStudyProgrammeTypeHookPlugin::allowSetDescription | ( | int | $type_id, |
| string | $lang_code, | ||
| string | $description | ||
| ) |
Return false if setting a description is not allowed.
Definition at line 46 of file class.ilStudyProgrammeTypeHookPlugin.php.
46 : bool
47 {
48 return true;
49 }
◆ allowSetTitle()
| ilStudyProgrammeTypeHookPlugin::allowSetTitle | ( | int | $type_id, |
| string | $lang_code, | ||
| string | $title | ||
| ) |
The following methods can be overridden by plugins.
Return false if setting a title is not allowed
Definition at line 38 of file class.ilStudyProgrammeTypeHookPlugin.php.
38 : bool
39 {
40 return true;
41 }
◆ allowUpdate()
| ilStudyProgrammeTypeHookPlugin::allowUpdate | ( | int | $type_id | ) |
Return false if StudyProgramme type is locked and no updates are possible.
Definition at line 70 of file class.ilStudyProgrammeTypeHookPlugin.php.
70 : bool
71 {
72 return true;
73 }
The documentation for this class was generated from the following file:
- components/ILIAS/StudyProgramme/classes/types/class.ilStudyProgrammeTypeHookPlugin.php
