ILIAS  release_4-4 Revision
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 ()
 Constructor. More...
 
 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 ()
 Update all languages. More...
 
 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...
 
 activate ()
 Activate. More...
 
 deactivate ()
 Deactivate. More...
 
 update ()
 Update plugin. More...
 
 lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
 Lookup name for id. More...
 
 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 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...
 
 beforeActivation ()
 Before activation processing. More...
 
 afterActivation ()
 After activation 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 _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)
 Create plugin record, if not existing. More...
 
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 plugins for a slot. More...
 
- Protected Attributes inherited from ilPlugin
 $lang_initialised = false
 

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 82 of file class.ilCloudHookPlugin.php.

References getPluginTablePrefix().

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

◆ getPluginTableName()

ilCloudHookPlugin::getPluginTableName ( )

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

References getPluginTablePrefix().

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

◆ getPluginTablePrefix()

ilCloudHookPlugin::getPluginTablePrefix ( )

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

References 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  {
71  $rec = ilPlugin::getPluginRecord($this->getComponentType(),$this->getComponentName(), $this->getSlotId(), $this->getPluginName());
72  $id = $rec['plugin_id'];
73  }
74  return $this->getSlotObject()->getPrefix() . "_" . $id;
75  }
getComponentName()
Get Component Name.
static getPluginRecord($a_ctype, $a_cname, $a_slot_id, $a_pname)
Get record from il_plugin table.
getId()
Get Id.
getComponentType()
Get Component Type.
getPluginName()
Get Plugin Name.
getSlotObject()
Get Plugin Slot.
+ 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: