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.
	getComponentName ()
	Get Component Name.
	getSlot ()
	Get Slot Name.
	getSlotId ()
	Get Slot ID.
	isValidParentType ($a_type)
	Determines the resources that allow to include the new content component.
	getUIText ($a_text_id)
	Determines the resources that allow to include the new content component.
	setMode ($a_mode)
	Set Mode.
	getMode ()
	Get Mode.
	setProperties ($a_properties)
	Set Properties.
	getProperties ()
	Get Properties.
	addSaveCancelButtons ($a_form)
	Add save cancel button to insert/edit form.
Public Member Functions inherited from ilPlugin
	__construct ()
	Constructor.
	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.
	updateDatabase ()
	Update database.
	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.
	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.

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.
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.
	init ()
	Object initialization.
	beforeActivation ()
	Before activation processing.
	afterActivation ()
	After activation processing.

Additional Inherited Members
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	lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
	Lookup language text.
static	_getImagePath ($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
	Get image path.
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.

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 34 of file class.ilPageComponentPlugin.php.

Member Function Documentation

ilPageComponentPlugin::addSaveCancelButtons ( $a_form )

final

Add save cancel button to insert/edit form.

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

References $lng, CMD_INSERT, and getMode().

        {
                global $lng;
                
                if ($this->getMode() == ilPageComponentPlugin::CMD_INSERT)
                {
                        $a_form->addCommandButton("create_plug", $lng->txt("save"));
                        $a_form->addCommandButton("cancelCreate", $lng->txt("cancel"));
                }
                else
                {
                        $a_form->addCommandButton("update_plug", $lng->txt("save"));
                        $a_form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
                }
        }

Here is the call graph for this function:

ilPageComponentPlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name

Reimplemented from ilPlugin.

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

        {
                return "COPage";
        }

ilPageComponentPlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Reimplemented from ilPlugin.

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

References IL_COMP_SERVICE.

        {
                return IL_COMP_SERVICE;
        }

ilPageComponentPlugin::getMode ( )

final

Get Mode.

Returns: string Mode

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

Referenced by addSaveCancelButtons().

        {
                return $this->mode;
        }

Here is the caller graph for this function:

ilPageComponentPlugin::getProperties ( )

final

Get Properties.

Returns: array Properties

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

        {
                return $this->properties;
        }

ilPageComponentPlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Reimplemented from ilPlugin.

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

        {
                return "PageComponent";
        }

ilPageComponentPlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id

Reimplemented from ilPlugin.

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

        {
                return "pgcp";
        }

ilPageComponentPlugin::getUIText ( $a_text_id )

abstract

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

Parameters

string $a_text_id values: TXT_CMD_INSERT

Returns: string User Interface Text String

ilPageComponentPlugin::isValidParentType ( $a_type )

abstract

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

Parameters

string $a_type Parent type (e.g. "cat", "lm", "glo", "wiki", ...)

Returns: boolean true/false if the resource type allows

ilPageComponentPlugin::setMode ( $a_mode )

final

Set Mode.

Parameters

string $a_mode Mode

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

        {
                $this->mode = $a_mode;
        }

ilPageComponentPlugin::setProperties ( $a_properties )

final

Set Properties.

Parameters

array $a_properties Properties

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

        {
                $this->properties = $a_properties;
        }

ilPageComponentPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

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

        {
                // nothing to do here
        }

Field Documentation

const ilPageComponentPlugin::CMD_EDIT = "edit"

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

Referenced by ilPCPluggedGUI\edit().

const ilPageComponentPlugin::CMD_INSERT = "insert"

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

Referenced by addSaveCancelButtons(), and ilPCPluggedGUI\edit().

const ilPageComponentPlugin::TXT_CMD_INSERT = "cmd_insert"

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

Referenced by ilPageObjectGUI\getComponentPluginsXML().

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

Services/COPage/classes/class.ilPageComponentPlugin.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation