PhpIncludeInspection More...

Inheritance diagram for ilComplexGatewayPlugin:

Collaboration diagram for ilComplexGatewayPlugin:

Public Member Functions
	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	evaluate (ilNode $context)
	This method is called by the workflow engine during the transition attempt. 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...

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

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

	afterDeactivation ()
	After deactivation processing. More...

	beforeUninstall ()

	afterUninstall ()

	beforeUpdate ()
	Before update processing. More...

	afterUpdate ()
	After update 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)

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

PhpIncludeInspection

Abstract parent class for all ComplexGateway plugin classes.

Author: Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

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

Member Function Documentation

◆ evaluate()

ilComplexGatewayPlugin::evaluate ( ilNode $context )

abstract

This method is called by the workflow engine during the transition attempt.

Here, the plugin delivers the black box which is called "complex" as the gateway. Return boolean to the engine, if the standard flow should be activated or the "else"-path.

Parameters

ilNode $context

Returns: boolean

Referenced by slotInit().

Here is the caller graph for this function:

◆ getComponentName()

ilComplexGatewayPlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name (WorkflowEngine)

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

         {
                 return 'WorkflowEngine';
         }

◆ getComponentType()

ilComplexGatewayPlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type (Service)

Definition at line 22 of file class.ilComplexGatewayPlugin.php.

References IL_COMP_SERVICE.

         {
                 return IL_COMP_SERVICE;
         }

◆ getSlot()

ilComplexGatewayPlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name (ComplexGateway)

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

         {
                 return 'ComplexGateway';
         }

◆ getSlotId()

ilComplexGatewayPlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id (wfecg)

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

         {
                 return "wfecg";
         }

◆ slotInit()

ilComplexGatewayPlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Definition at line 60 of file class.ilComplexGatewayPlugin.php.

References evaluate().

60 {}

Here is the call graph for this function:

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

Services/WorkflowEngine/classes/class.ilComplexGatewayPlugin.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ evaluate()

◆ getComponentName()

◆ getComponentType()

◆ getSlot()

◆ getSlotId()

◆ slotInit()