Inheritance diagram for ilDclFieldTypePlugin:

Collaboration diagram for ilDclFieldTypePlugin:

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

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	getPluginTablePrefix ()

	getPluginTableName ()

	getPluginConfigTableName ()

	getPluginClassPrefix ()

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

Static Public Member Functions
static	getInstance ()
	Singleton for abstract class. More...

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

Data Fields
const	COMPONENT_NAME = "DataCollection"

const	SLOT_NAME = "FieldTypeHook"

const	SLOT_ID = "dclfth"

const	CONFIG_FIELD_MODEL = "field_model"

const	CONFIG_RECORD_MODEL = "record_model"

const	CONFIG_RECORD_FIELD_MODEL = "record_field_model"

const	CONFIG_FIELD_REPRESENTATION = "field_representation"

const	CONFIG_RECORD_REPRESENTATION = "record_representation"

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

Static Protected Attributes
static	$instances = array()

Additional Inherited Members
Protected Attributes inherited from ilPlugin
	$lang_initialised = false

	$id = ''

Detailed Description

Class ilDclFieldTypePlugin.

Definition of the PluginHook

Author: Michael Herren

Definition at line 14 of file class.ilDclFieldTypePlugin.php.

Member Function Documentation

◆ getComponentName()

ilDclFieldTypePlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name

Definition at line 59 of file class.ilDclFieldTypePlugin.php.

Referenced by getPluginTablePrefix().

     {
         return self::COMPONENT_NAME;
     }

Here is the caller graph for this function:

◆ getComponentType()

ilDclFieldTypePlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Definition at line 49 of file class.ilDclFieldTypePlugin.php.

References IL_COMP_MODULE.

Referenced by getPluginTablePrefix().

     {
         return IL_COMP_MODULE;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilDclFieldTypePlugin::getInstance ( )

static

Singleton for abstract class.

Returns: ilDclFieldTypePlugin

Definition at line 35 of file class.ilDclFieldTypePlugin.php.

     {
         $class = get_called_class();
         if (!isset(self::$instances[$class])) {
             self::$instances[$class] = new $class();
         }
         return self::$instances[$class];
     }

◆ getPluginClassPrefix()

ilDclFieldTypePlugin::getPluginClassPrefix ( )

Definition at line 112 of file class.ilDclFieldTypePlugin.php.

     {
         return 'il';
     }

◆ getPluginConfigTableName()

ilDclFieldTypePlugin::getPluginConfigTableName ( )

Definition at line 107 of file class.ilDclFieldTypePlugin.php.

References getPluginTablePrefix().

     {
         return $this->getPluginTablePrefix() . "_config";
     }

Here is the call graph for this function:

◆ getPluginTableName()

ilDclFieldTypePlugin::getPluginTableName ( )

Definition at line 102 of file class.ilDclFieldTypePlugin.php.

References getPluginTablePrefix().

     {
         return $this->getPluginTablePrefix() . "_props";
     }

Here is the call graph for this function:

◆ getPluginTablePrefix()

ilDclFieldTypePlugin::getPluginTablePrefix ( )

Definition at line 92 of file class.ilDclFieldTypePlugin.php.

References ilPlugin\$id, getComponentName(), getComponentType(), ilPlugin\getId(), ilPlugin\getPluginName(), ilPlugin\getPluginRecord(), getSlotId(), and ilPlugin\getSlotObject().

Referenced by getPluginConfigTableName(), and getPluginTableName().

     {
         $id = $this->getId();
         if (!$id) {
             $rec = ilPlugin::getPluginRecord($this->getComponentType(), $this->getComponentName(), $this->getSlotId(), $this->getPluginName());
             $id = $rec['plugin_id'];
         }
         return $this->getSlotObject()->getPrefix() . "_" . $id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSlot()

ilDclFieldTypePlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Definition at line 69 of file class.ilDclFieldTypePlugin.php.

     {
         return self::SLOT_NAME;
     }

◆ getSlotId()

ilDclFieldTypePlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id

Definition at line 79 of file class.ilDclFieldTypePlugin.php.

Referenced by getPluginTablePrefix().

     {
         return self::SLOT_ID;
     }

Here is the caller graph for this function:

◆ slotInit()

ilDclFieldTypePlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Definition at line 87 of file class.ilDclFieldTypePlugin.php.

     {
         // nothing to do here
     }

Field Documentation

◆ $instances

ilDclFieldTypePlugin::$instances = array()

staticprotected

Definition at line 28 of file class.ilDclFieldTypePlugin.php.

◆ COMPONENT_NAME

const ilDclFieldTypePlugin::COMPONENT_NAME = "DataCollection"

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

Referenced by ilDclPluginFieldRepresentation\buildFieldCreationInput(), ilDclFieldFactory\getClassPathByInstance(), and ilDclFieldFactory\getFieldTypeByInstance().

◆ CONFIG_FIELD_MODEL

const ilDclFieldTypePlugin::CONFIG_FIELD_MODEL = "field_model"

Definition at line 20 of file class.ilDclFieldTypePlugin.php.

◆ CONFIG_FIELD_REPRESENTATION

const ilDclFieldTypePlugin::CONFIG_FIELD_REPRESENTATION = "field_representation"

Definition at line 23 of file class.ilDclFieldTypePlugin.php.

◆ CONFIG_RECORD_FIELD_MODEL

const ilDclFieldTypePlugin::CONFIG_RECORD_FIELD_MODEL = "record_field_model"

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

◆ CONFIG_RECORD_MODEL

const ilDclFieldTypePlugin::CONFIG_RECORD_MODEL = "record_model"

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

◆ CONFIG_RECORD_REPRESENTATION

const ilDclFieldTypePlugin::CONFIG_RECORD_REPRESENTATION = "record_representation"

Definition at line 24 of file class.ilDclFieldTypePlugin.php.

◆ SLOT_ID

const ilDclFieldTypePlugin::SLOT_ID = "dclfth"

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

Referenced by ilDclPluginFieldRepresentation\buildFieldCreationInput(), ilDclFieldFactory\getClassPathByInstance(), and ilDclFieldFactory\getFieldTypeByInstance().

◆ SLOT_NAME

const ilDclFieldTypePlugin::SLOT_NAME = "FieldTypeHook"

Definition at line 17 of file class.ilDclFieldTypePlugin.php.

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

Modules/DataCollection/classes/Fields/Plugin/class.ilDclFieldTypePlugin.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getComponentName()

◆ getComponentType()

◆ getInstance()

◆ getPluginClassPrefix()

◆ getPluginConfigTableName()

◆ getPluginTableName()

◆ getPluginTablePrefix()

◆ getSlot()

◆ getSlotId()

◆ slotInit()

Field Documentation

◆ $instances

◆ COMPONENT_NAME

◆ CONFIG_FIELD_MODEL

◆ CONFIG_FIELD_REPRESENTATION

◆ CONFIG_RECORD_FIELD_MODEL

◆ CONFIG_RECORD_MODEL

◆ CONFIG_RECORD_REPRESENTATION

◆ SLOT_ID

◆ SLOT_NAME