ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilCloudHookPlugin Class Reference

Class ilCloudHookPlugin. More...

+ Inheritance diagram for ilCloudHookPlugin:
+ Collaboration diagram for ilCloudHookPlugin:

Public Member Functions

 getComponentType ()
 Get Component Type. More...
 
 getComponentName ()
 Get Component Name. More...
 
 getSlot ()
 Get Slot Name. More...
 
 getSlotId ()
 Get Slot ID. More...
 
 getPluginTablePrefix ()
 
 getPluginTableName ()
 
 getPluginConfigTableName ()
 
- 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 ()
 

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 = ''
 

Detailed Description

Class ilCloudHookPlugin.

Definition of the PluginHook

Author
Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch
Version
$Id$

Definition at line 16 of file class.ilCloudHookPlugin.php.

Member Function Documentation

◆ getComponentName()

ilCloudHookPlugin::getComponentName ( )
final

Get Component Name.

Returns
string Component Name

Definition at line 33 of file class.ilCloudHookPlugin.php.

Referenced by getPluginTablePrefix().

34  {
35  return "Cloud";
36  }
+ Here is the caller graph for this function:

◆ getComponentType()

ilCloudHookPlugin::getComponentType ( )
final

Get Component Type.

Returns
string Component Type

Definition at line 23 of file class.ilCloudHookPlugin.php.

References IL_COMP_MODULE.

Referenced by getPluginTablePrefix().

24  {
25  return IL_COMP_MODULE;
26  }
const IL_COMP_MODULE
+ Here is the caller graph for this function:

◆ getPluginConfigTableName()

ilCloudHookPlugin::getPluginConfigTableName ( )

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

References getPluginTablePrefix().

82  {
83  return $this->getPluginTablePrefix() . "_config";
84  }
+ Here is the call graph for this function:

◆ getPluginTableName()

ilCloudHookPlugin::getPluginTableName ( )

Definition at line 76 of file class.ilCloudHookPlugin.php.

References getPluginTablePrefix().

77  {
78  return $this->getPluginTablePrefix() . "_props";
79  }
+ Here is the call graph for this function:

◆ getPluginTablePrefix()

ilCloudHookPlugin::getPluginTablePrefix ( )

Definition at line 66 of file class.ilCloudHookPlugin.php.

References ilPlugin\$id, getComponentName(), getComponentType(), ilPlugin\getId(), ilPlugin\getPluginName(), ilPlugin\getPluginRecord(), getSlotId(), and ilPlugin\getSlotObject().

Referenced by getPluginConfigTableName(), and getPluginTableName().

67  {
68  $id = $this->getId();
69  if (!$id) {
70  $rec = ilPlugin::getPluginRecord($this->getComponentType(), $this->getComponentName(), $this->getSlotId(), $this->getPluginName());
71  $id = $rec['plugin_id'];
72  }
73  return $this->getSlotObject()->getPrefix() . "_" . $id;
74  }
static getPluginRecord(string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
getComponentName()
Get Component Name.
getComponentType()
Get Component Type.
getPluginName()
Get Plugin Name.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSlot()

ilCloudHookPlugin::getSlot ( )
final

Get Slot Name.

Returns
string Slot Name

Definition at line 43 of file class.ilCloudHookPlugin.php.

44  {
45  return "CloudHook";
46  }

◆ getSlotId()

ilCloudHookPlugin::getSlotId ( )
final

Get Slot ID.

Returns
string Slot Id

Definition at line 53 of file class.ilCloudHookPlugin.php.

Referenced by getPluginTablePrefix().

54  {
55  return "cldh";
56  }
+ Here is the caller graph for this function:

◆ slotInit()

ilCloudHookPlugin::slotInit ( )
finalprotected

Object initialization done by slot.

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

62  {
63  // nothing to do here
64  }

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