ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilOrgUnitExtensionPlugin Class Reference

Class ilOrgUnitExtensionPlugin. More...

+ Inheritance diagram for ilOrgUnitExtensionPlugin:
+ Collaboration diagram for ilOrgUnitExtensionPlugin:

Public Member Functions

 getComponentType ()
 Get Component Type. More...
 
 getComponentName ()
 Get Component Name. More...
 
 getSlot ()
 Get Slot Name. More...
 
 getSlotId ()
 Get Slot ID. More...
 
 getParentTypes ()
 
 showInTree ()
 return true iff this item should be displayed in the tree. More...
 
- Public Member Functions inherited from ilRepositoryObjectPlugin
 __construct ()
 Constructor. More...
 
 getComponentType ()
 Get Component Type. More...
 
 getComponentName ()
 Get Component Name. More...
 
 getSlot ()
 Get Slot Name. More...
 
 getSlotId ()
 Get Slot ID. More...
 
 getParentTypes ()
 
 allowCopy ()
 decides if this repository plugin can be copied 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...
 

Static Public Member Functions

static _getIcon ($a_type, $a_size)
 
static _getName ($a_id)
 
- Static Public Member Functions inherited from ilRepositoryObjectPlugin
static _getIcon ($a_type, $a_size)
 Get Icon. More...
 
static _getName ($a_id)
 Get class name. More...
 
- 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 Member Functions

 slotInit ()
 Object initialization done by slot. More...
 
- Protected Member Functions inherited from ilRepositoryObjectPlugin
 slotInit ()
 Object initialization done by slot. More...
 
 beforeActivation ()
 Before activation processing. More...
 
 beforeUninstallCustom ()
 
 uninstallCustom ()
 
 beforeUninstall ()
 
- 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

- Protected Attributes inherited from ilRepositoryObjectPlugin
 $lng
 
 $db
 
- Protected Attributes inherited from ilPlugin
 $lang_initialised = false
 
 $id = ''
 

Detailed Description

Member Function Documentation

◆ _getIcon()

static ilOrgUnitExtensionPlugin::_getIcon (   $a_type,
  $a_size 
)
static
Parameters
$a_type
$a_size
Returns
string

Definition at line 81 of file class.ilOrgUnitExtensionPlugin.php.

References $a_type, ilPlugin\_getImagePath(), IL_COMP_MODULE, and ilPlugin\lookupNameForId().

82  {
83  return ilPlugin::_getImagePath(IL_COMP_MODULE, "OrgUnit", "orguext", ilPlugin::lookupNameForId(IL_COMP_MODULE, "OrgUnit", "orguext", $a_type), "icon_"
84  . $a_type
85  . ".svg");
86  }
static _getImagePath( $a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
Get image path.
$a_type
Definition: workflow.php:92
static lookupNameForId($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
Lookup name for id.
const IL_COMP_MODULE
+ Here is the call graph for this function:

◆ _getName()

static ilOrgUnitExtensionPlugin::_getName (   $a_id)
static
Parameters
$a_id
Returns
string

Definition at line 93 of file class.ilOrgUnitExtensionPlugin.php.

References $name, IL_COMP_MODULE, and ilPlugin\lookupNameForId().

94  {
95  $name = ilPlugin::lookupNameForId(IL_COMP_MODULE, "Repository", "orguext", $a_id);
96  if ($name != "") {
97  return $name;
98  }
99  }
if($format !==null) $name
Definition: metadata.php:146
static lookupNameForId($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
Lookup name for id.
const IL_COMP_MODULE
+ Here is the call graph for this function:

◆ getComponentName()

ilOrgUnitExtensionPlugin::getComponentName ( )
final

Get Component Name.

Returns
string Component Name

Definition at line 28 of file class.ilOrgUnitExtensionPlugin.php.

29  {
30  return 'OrgUnit';
31  }

◆ getComponentType()

ilOrgUnitExtensionPlugin::getComponentType ( )
final

Get Component Type.

Returns
string Component Type

Definition at line 17 of file class.ilOrgUnitExtensionPlugin.php.

References IL_COMP_MODULE.

18  {
19  return IL_COMP_MODULE;
20  }
const IL_COMP_MODULE

◆ getParentTypes()

ilOrgUnitExtensionPlugin::getParentTypes ( )
Returns
array

Definition at line 68 of file class.ilOrgUnitExtensionPlugin.php.

References array.

69  {
70  $par_types = array( "orgu" );
71 
72  return $par_types;
73  }
Create styles array
The data for the language used.

◆ getSlot()

ilOrgUnitExtensionPlugin::getSlot ( )
final

Get Slot Name.

Returns
string Slot Name

Definition at line 39 of file class.ilOrgUnitExtensionPlugin.php.

40  {
41  return 'OrgUnitExtension';
42  }

◆ getSlotId()

ilOrgUnitExtensionPlugin::getSlotId ( )
final

Get Slot ID.

Returns
string Slot Id

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

51  {
52  return 'orguext';
53  }

◆ showInTree()

ilOrgUnitExtensionPlugin::showInTree ( )

return true iff this item should be displayed in the tree.

Returns
bool

Definition at line 107 of file class.ilOrgUnitExtensionPlugin.php.

108  {
109  return false;
110  }

◆ slotInit()

ilOrgUnitExtensionPlugin::slotInit ( )
finalprotected

Object initialization done by slot.

Definition at line 59 of file class.ilOrgUnitExtensionPlugin.php.

60  {
61  // nothing to do here
62  }

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