ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilCachedPlugin Class Reference

Class ilCachedPlugin. More...

+ Inheritance diagram for ilCachedPlugin:
+ Collaboration diagram for ilCachedPlugin:

Public Member Functions

 updateDatabase ()
 Update database.
 lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
 Lookup name for id.
 lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
 Lookup id for name.
- Public Member Functions inherited from ilPlugin
 __construct ()
 Constructor.
 getComponentType ()
 Get Component Type.
 getComponentName ()
 Get Component Name.
 getSlot ()
 Get Slot Name.
 getSlotId ()
 Get Slot ID.
 getPluginName ()
 Get Plugin Name.
 getId ()
 Get Id.
 getLastUpdateVersion ()
 Get Version of last update.
 getVersion ()
 Get Current Version (from plugin.php file).
 getIliasMinVersion ()
 Get Required ILIAS min.
 getIliasMaxVersion ()
 Get Required ILIAS max.
 getActive ()
 Get Active.
 setDBVersion ($a_dbversion)
 Set DB Version.
 getDBVersion ()
 Get DB Version.
 writeDBVersion ($a_dbversion)
 Write DB version to database.
 getDirectory ()
 Get Plugin Directory.
 includeClass ($a_class_file_name)
 Include (once) a class file.
 getPrefix ()
 Get plugin prefix, used for lang vars.
 getTablePrefix ()
 Get db table plugin prefix.
 updateLanguages ()
 Update all languages.
 loadLanguageModule ()
 Load language module for plugin.
 txt ($a_var)
 Get Language Variable (prefix will be prepended automatically)
 getTemplate ($a_template, $a_par1=true, $a_par2=true)
 Get template from plugin.
 getImagePath ($a_img)
 Get image path.
 getStyleSheetLocation ($a_css_file)
 Get css file location.
 addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
 Add template content to placeholder variable.
 isActive ()
 Check whether plugin is active.
 needsUpdate ()
 Check whether update is needed.
 activate ()
 Activate.
 deactivate ()
 Deactivate.
 update ()
 Update plugin.

Static Public Member Functions

static lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
 Lookup language text.
- Static Public Member Functions inherited from ilPlugin
static _getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname)
 Get plugin directory.
static getAvailableLangFiles ($a_lang_directory)
 Get array of all language files in the plugin.
static hasConfigureClass ($a_slot_dir, $a_name)
 Has the plugin a configure class?
static getConfigureClassName ($a_name)
 Get plugin configure class name.
static getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
 Get DB update script filename (full path)
static _getImagePath ($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
 Get image path.
static createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
 Create plugin record, if not existing.
static getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
 Get record from il_plugin table.
static getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
 Get plugin object.
static lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
 Lookup information data in il_plugin.
static getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
 Get all active plugins for a slot.

Protected Member Functions

 init ()
 Object initialization.
 beforeActivation ()
 Before activation processing.
 afterActivation ()
 After activation processing.
 afterDeactivation ()
 After deactivation processing.
 beforeUpdate ()
 Before update processing.
 afterUpdate ()
 After update processing.
- Protected Member Functions inherited from ilPlugin
 setSlotObject ($a_slot)
 Set Plugin Slot.
 getSlotObject ()
 Get Plugin Slot.
 getClassesDirectory ()
 Get Plugin's classes Directory.
 getLanguageDirectory ()
 Get Plugin's language Directory.
 slotInit ()
 Object initialization done by slot.

Additional Inherited Members

- Protected Attributes inherited from ilPlugin
 $lang_initialised = false

Detailed Description

Class ilCachedPlugin.

Author
Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Version
1.0.0

Definition at line 9 of file class.ilCachedPlugin.php.

Member Function Documentation

ilCachedPlugin::afterActivation ( )
protected

After activation processing.

Reimplemented from ilPlugin.

Definition at line 31 of file class.ilCachedPlugin.php.

{
parent::afterActivation(); // TODO: Change the autogenerated stub
}
ilCachedPlugin::afterDeactivation ( )
protected

After deactivation processing.

Reimplemented from ilPlugin.

Definition at line 36 of file class.ilCachedPlugin.php.

{
parent::afterDeactivation(); // TODO: Change the autogenerated stub
}
ilCachedPlugin::afterUpdate ( )
protected

After update processing.

Reimplemented from ilPlugin.

Definition at line 46 of file class.ilCachedPlugin.php.

{
parent::afterUpdate(); // TODO: Change the autogenerated stub
}
ilCachedPlugin::beforeActivation ( )
protected

Before activation processing.

Reimplemented from ilPlugin.

Definition at line 26 of file class.ilCachedPlugin.php.

{
return parent::beforeActivation(); // TODO: Change the autogenerated stub
}
ilCachedPlugin::beforeUpdate ( )
protected

Before update processing.

Reimplemented from ilPlugin.

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

{
return parent::beforeUpdate(); // TODO: Change the autogenerated stub
}
ilCachedPlugin::init ( )
protected

Object initialization.

Can be overwritten by plugin class (and should be made protected final)

Reimplemented from ilPlugin.

Definition at line 21 of file class.ilCachedPlugin.php.

{
parent::init(); // TODO: Change the autogenerated stub
}
ilCachedPlugin::lookupIdForName (   $a_ctype,
  $a_cname,
  $a_slot_id,
  $a_plugin_name 
)

Lookup id for name.

Reimplemented from ilPlugin.

Definition at line 56 of file class.ilCachedPlugin.php.

{
return parent::lookupIdForName($a_ctype, $a_cname, $a_slot_id, $a_plugin_name); // TODO: Change the autogenerated stub
}
ilCachedPlugin::lookupNameForId (   $a_ctype,
  $a_cname,
  $a_slot_id,
  $a_plugin_id 
)

Lookup name for id.

Reimplemented from ilPlugin.

Definition at line 51 of file class.ilCachedPlugin.php.

{
return parent::lookupNameForId($a_ctype, $a_cname, $a_slot_id, $a_plugin_id); // TODO: Change the autogenerated stub
}
static ilCachedPlugin::lookupTxt (   $a_mod_prefix,
  $a_pl_id,
  $a_lang_var 
)
static

Lookup language text.

Reimplemented from ilPlugin.

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

{
return parent::lookupTxt($a_mod_prefix, $a_pl_id, $a_lang_var); // TODO: Change the autogenerated stub
}
ilCachedPlugin::updateDatabase ( )

Update database.

Reimplemented from ilPlugin.

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

{
return parent::updateDatabase(); // TODO: Change the autogenerated stub
}

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