ILIAS  release_4-4 Revision
ilPageComponentPlugin Class Reference

Abstract parent class for all page component plugin classes. More...

+ Inheritance diagram for ilPageComponentPlugin:
+ Collaboration diagram for ilPageComponentPlugin:

Public Member Functions

 getComponentType ()
 Get Component Type. More...
 
 getComponentName ()
 Get Component Name. More...
 
 getSlot ()
 Get Slot Name. More...
 
 getSlotId ()
 Get Slot ID. More...
 
 isValidParentType ($a_type)
 Determines the resources that allow to include the new content component. More...
 
 getJavascripFiles ()
 Get Javascript files. More...
 
 getCssFiles ()
 Get css files. More...
 
 setMode ($a_mode)
 Set Mode. More...
 
 getMode ()
 Get Mode. More...
 
 getUIClassInstance ()
 Get UI plugin class. More...
 
- 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...
 

Data Fields

const TXT_CMD_INSERT = "cmd_insert"
 
const CMD_INSERT = "insert"
 
const CMD_EDIT = "edit"
 

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

Abstract parent class for all page component plugin classes.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 15 of file class.ilPageComponentPlugin.php.

Member Function Documentation

◆ getComponentName()

ilPageComponentPlugin::getComponentName ( )
final

Get Component Name.

Returns
string Component Name

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

37  {
38  return "COPage";
39  }

◆ getComponentType()

ilPageComponentPlugin::getComponentType ( )
final

Get Component Type.

Returns
string Component Type

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

References IL_COMP_SERVICE.

27  {
28  return IL_COMP_SERVICE;
29  }
const IL_COMP_SERVICE

◆ getCssFiles()

ilPageComponentPlugin::getCssFiles ( )

Get css files.

Definition at line 90 of file class.ilPageComponentPlugin.php.

91  {
92  return array();
93  }

◆ getJavascripFiles()

ilPageComponentPlugin::getJavascripFiles ( )

Get Javascript files.

Definition at line 82 of file class.ilPageComponentPlugin.php.

83  {
84  return array();
85  }

◆ getMode()

ilPageComponentPlugin::getMode ( )
final

Get Mode.

Returns
string Mode

Definition at line 110 of file class.ilPageComponentPlugin.php.

111  {
112  return $this->mode;
113  }

◆ getSlot()

ilPageComponentPlugin::getSlot ( )
final

Get Slot Name.

Returns
string Slot Name

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

47  {
48  return "PageComponent";
49  }

◆ getSlotId()

ilPageComponentPlugin::getSlotId ( )
final

Get Slot ID.

Returns
string Slot Id

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

57  {
58  return "pgcp";
59  }

◆ getUIClassInstance()

ilPageComponentPlugin::getUIClassInstance ( )

Get UI plugin class.

Definition at line 118 of file class.ilPageComponentPlugin.php.

References ilPlugin\includeClass().

119  {
120  $class = "il".$this->getPluginName()."PluginGUI";
121  $this->includeClass("class.".$class.".php");
122  $obj = new $class();
123  $obj->setPlugin($this);
124  return $obj;
125  }
includeClass($a_class_file_name)
Include (once) a class file.
+ Here is the call graph for this function:

◆ isValidParentType()

ilPageComponentPlugin::isValidParentType (   $a_type)
abstract

Determines the resources that allow to include the new content component.

Parameters
string$a_typeParent type (e.g. "cat", "lm", "glo", "wiki", ...)
Returns
boolean true/false if the resource type allows

Referenced by slotInit().

+ Here is the caller graph for this function:

◆ setMode()

ilPageComponentPlugin::setMode (   $a_mode)
final

Set Mode.

Parameters
string$a_modeMode

Definition at line 100 of file class.ilPageComponentPlugin.php.

101  {
102  $this->mode = $a_mode;
103  }

◆ slotInit()

ilPageComponentPlugin::slotInit ( )
finalprotected

Object initialization done by slot.

Definition at line 64 of file class.ilPageComponentPlugin.php.

References isValidParentType().

65  {
66  // nothing to do here
67  }
+ Here is the call graph for this function:

Field Documentation

◆ CMD_EDIT

const ilPageComponentPlugin::CMD_EDIT = "edit"

◆ CMD_INSERT

const ilPageComponentPlugin::CMD_INSERT = "insert"

◆ TXT_CMD_INSERT

const ilPageComponentPlugin::TXT_CMD_INSERT = "cmd_insert"

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