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...

	getJavascriptFiles ($a_mode)
	Get Javascript files. More...

	getCssFiles ($a_mode)
	Get css files. More...

	setMode ($a_mode)
	Set Mode. More...

	getMode ()
	Get Mode. More...

	getUIClassInstance ()
	Get UI plugin class. More...

	setPageObj ($a_page_obj)
	Inject the page object This must be public to be called by ilPCPlugged But the page object should not directly be accessible by plugins. More...

	getPageId ()
	Get the id of the page. More...

	getParentId ()
	Get the object id of the parent object. More...

	getParentType ()
	Get the object type og the parent object. More...

	onClone (&$a_properties, $a_plugin_version)
	This function is called when the page content is cloned. More...

	onDelete ($a_properties, $a_plugin_version)
	This function is called before the page content is deleted. More...

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 ()
	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 ($a_lang_keys=null)

	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...

	install ()
	Install. More...

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. 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...

	afterInstall ()
	After install processing. More...

	beforeActivation ()
	Before activation processing. More...

	afterActivation ()
	After activation processing. More...

	afterDeactivation ()
	After deactivation processing. More...

	beforeUninstall ()

	afterUninstall ()

	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...

Private Attributes
	$page_obj = null

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	langExitsById ($pluginId, $langVar)
	Is searched lang var available in plugin lang files. 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)

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 plugin names for a slot. More...

static	getActivePluginIdsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get All active plugin ids for a slot. More...

static	lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
	Lookup name for id. More...

static	lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
	Lookup id for name. More...

Protected Attributes inherited from ilPlugin
	$lang_initialised = false

	$id = ''

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

Reimplemented from ilPlugin.

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

    {
        return "COPage";
    }

◆ getComponentType()

ilPageComponentPlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Reimplemented from ilPlugin.

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

    {
        return IL_COMP_SERVICE;
    }

References IL_COMP_SERVICE.

◆ getCssFiles()

ilPageComponentPlugin::getCssFiles ( $a_mode )

Get css files.

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

    {
        return array();
    }

◆ getJavascriptFiles()

ilPageComponentPlugin::getJavascriptFiles ( $a_mode )

Get Javascript files.

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

    {
        return array();
    }

◆ getMode()

ilPageComponentPlugin::getMode ( )

final

Get Mode.

Returns: string Mode

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

    {
        return $this->mode;
    }

◆ getPageId()

ilPageComponentPlugin::getPageId ( )

Get the id of the page.

Returns: int

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

    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getId();
        }
        return 0;
    }

◆ getParentId()

ilPageComponentPlugin::getParentId ( )

Get the object id of the parent object.

Returns: int

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

    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getParentId();
        }
        return 0;
    }

◆ getParentType()

ilPageComponentPlugin::getParentType ( )

Get the object type og the parent object.

Returns: string

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

    {
        if (isset($this->page_obj)) {
            return $this->page_obj->getParentType();
        }
        return '';
    }

◆ getSlot()

ilPageComponentPlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Reimplemented from ilPlugin.

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

    {
        return "PageComponent";
    }

◆ getSlotId()

ilPageComponentPlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id

Reimplemented from ilPlugin.

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

    {
        return "pgcp";
    }

◆ getUIClassInstance()

ilPageComponentPlugin::getUIClassInstance ( )

Get UI plugin class.

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

    {
        $class = "il" . $this->getPluginName() . "PluginGUI";
        $this->includeClass("class." . $class . ".php");
        $obj = new $class();
        $obj->setPlugin($this);
        return $obj;
    }

References ilPlugin\getPluginName(), and ilPlugin\includeClass().

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_type Parent type (e.g. "cat", "lm", "glo", "wiki", ...)

Returns: boolean true/false if the resource type allows

◆ onClone()

ilPageComponentPlugin::onClone	(	&	$a_properties,
			$a_plugin_version
	)

This function is called when the page content is cloned.

Parameters

array	$a_properties	(properties saved in the page, should be modified if neccessary)
string	$a_plugin_version	(plugin version of the properties)

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

186 {

187 }

◆ onDelete()

ilPageComponentPlugin::onDelete	(	$a_properties,
		$a_plugin_version
	)

This function is called before the page content is deleted.

Parameters

array	$a_properties	properties saved in the page (will be deleted afterwards)
string	$a_plugin_version	plugin version of the properties

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

195 {

196 }

◆ setMode()

ilPageComponentPlugin::setMode ( $a_mode )

final

Set Mode.

Parameters

string $a_mode Mode

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

    {
        $this->mode = $a_mode;
    }

◆ setPageObj()

ilPageComponentPlugin::setPageObj ( $a_page_obj )

Inject the page object This must be public to be called by ilPCPlugged But the page object should not directly be accessible by plugins.

Parameters

ilPageObject

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

    {
        $this->page_obj = $a_page_obj;
    }

◆ slotInit()

ilPageComponentPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

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

    {
        // nothing to do here
    }

Field Documentation

◆ $page_obj

ilPageComponentPlugin::$page_obj = null

private

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

◆ CMD_EDIT

const ilPageComponentPlugin::CMD_EDIT = "edit"

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

Referenced by ilPCPluggedGUI\edit(), and ilPageComponentPluginGUI\getHTML().

◆ CMD_INSERT

const ilPageComponentPlugin::CMD_INSERT = "insert"

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

Referenced by ilPCPluggedGUI\edit(), and ilPageComponentPluginGUI\getHTML().

◆ TXT_CMD_INSERT

const ilPageComponentPlugin::TXT_CMD_INSERT = "cmd_insert"

Definition at line 17 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

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getComponentName()

◆ getComponentType()

◆ getCssFiles()

◆ getJavascriptFiles()

◆ getMode()

◆ getPageId()

◆ getParentId()

◆ getParentType()

◆ getSlot()

◆ getSlotId()

◆ getUIClassInstance()

◆ isValidParentType()

◆ onClone()

◆ onDelete()

◆ setMode()

◆ setPageObj()

◆ slotInit()

Field Documentation

◆ $page_obj

◆ CMD_EDIT

◆ CMD_INSERT

◆ TXT_CMD_INSERT