Inheritance diagram for ilDclFieldTypePlugin:

Collaboration diagram for ilDclFieldTypePlugin:

Public Member Functions
	install ()

	getStorageLocation ()

Public Member Functions inherited from ilPlugin
	getMessage ()

	__construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id)

	getPluginName ()

	getId ()

	getVersion ()
	Only very little classes seem to care about this: More...

	getDirectory ()
	Only very little classes seem to care about this: More...

	isActive ()
	Only very little classes seem to care about this: More...

	needsUpdate ()

	install ()

	uninstall ()

	activate ()
	This will update (if required) and activate the plugin. More...

	deactivate ()

	update ()

	loadLanguageModule ()
	Load language module for plugin. More...

	txt (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...

	getStyleSheetLocation (string $a_css_file)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...

	getGlobalScreenProviderCollection ()

	exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic)
	This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More...

	exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic)
	This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More...

Static Public Member Functions
static	getDataType (string $plugin_id)

static	getPluginId (string $datatype)

static	isPluginDatatype (string $datatype)

Data Fields
const	ID_BUFFER = 1000

const	DB_TYPES = ['text', 'text', 'integer', 'date']

const	COMPONENT_NAME = "DataCollection"

const	SLOT_ID = "dclfth"

const	PLUGIN_SLOT_PREFIX = 'plugin_fth_'

Additional Inherited Members
Protected Member Functions inherited from ilPlugin
	init ()
	Object initialization. More...

	getPluginInfo ()

	getComponentInfo ()

	getPluginSlotInfo ()

	afterInstall ()
	If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...

	beforeUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	afterUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...

	beforeActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	afterDeactivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...

	updateDatabase ()

	beforeUpdate ()
	If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More...

	afterUpdate ()

	getLanguageHandler ()

	buildLanguageHandler ()

Protected Attributes inherited from ilPlugin
ilDBInterface	$db

ilComponentRepositoryWrite	$component_repository

string	$id

ilPluginLanguage	$language_handler = null

bool	$lang_initialised = false

ProviderCollection	$provider_collection

string	$message = ''

Detailed Description

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

Member Function Documentation

◆ getDataType()

static ilDclFieldTypePlugin::getDataType ( string $plugin_id )

static

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

Referenced by ilDataCollectionDBUpdateSteps9\step_16().

                                                          : string
     {
         return self::PLUGIN_SLOT_PREFIX . $plugin_id;
     }

Here is the caller graph for this function:

◆ getPluginId()

static ilDclFieldTypePlugin::getPluginId ( string $datatype )

static

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

Referenced by ilDclDatatype\getAllDatatype(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), ilDclPluginFieldModel\getPresentationDescription(), and ilDclPluginFieldModel\getPresentationTitle().

                                                         : string
     {
         if (self::isPluginDatatype($datatype)) {
             return substr($datatype, strlen(self::PLUGIN_SLOT_PREFIX));
         }
         throw new ilPluginException('Invalid datatype prefix for FieldTypHook-plugin');
     }

Here is the caller graph for this function:

◆ getStorageLocation()

ilDclFieldTypePlugin::getStorageLocation ( )

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

Referenced by install().

Here is the caller graph for this function:

◆ install()

ilDclFieldTypePlugin::install ( )

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

References ilDclDatatype\getAllDatatype(), ilPlugin\getId(), ilPlugin\getPluginName(), getStorageLocation(), PLUGIN_SLOT_PREFIX, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                              : void
     {
         $field_type_name = ilDclFieldTypePlugin::PLUGIN_SLOT_PREFIX . $this->getId();
         $datatypes = ilDclDatatype::getAllDatatype(true);
         foreach ($datatypes as $datatype) {
             if ($datatype->getTitle() === $field_type_name) {
                 parent::install();
                 return;
             }
         }
 
         $field_model_class = 'il' . $this->getPluginName() . 'FieldModel';
         $type = (new $field_model_class())->getStorageLocationOverride() ?? $this->getStorageLocation();
         $this->db->manipulateF(
             'INSERT INTO il_dcl_datatype (id, title, storage_location, sort) SELECT GREATEST(MAX(id), %s) + 1, %s, %s, GREATEST(MAX(sort), %s * 10) + 10 FROM il_dcl_datatype;',
             [
                 ilDBConstants::T_INTEGER,
                 ilDBConstants::T_TEXT,
                 ilDBConstants::T_INTEGER,
                 ilDBConstants::T_INTEGER,
             ],
             [
                 self::ID_BUFFER,
                 $field_type_name,
                 $type,
                 self::ID_BUFFER
             ]
         );
     }

Here is the call graph for this function:

◆ isPluginDatatype()

static ilDclFieldTypePlugin::isPluginDatatype ( string $datatype )

static

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

Referenced by ilDclDatatype\getAllDatatype(), ilDclFieldFactory\getClassPathByInstance(), ilDclFieldFactory\getFieldTypeByInstance(), and ilDataCollectionDataSet\getXmlNamespace().

                                                              : bool
     {
         return substr($datatype, 0, strlen(self::PLUGIN_SLOT_PREFIX)) === self::PLUGIN_SLOT_PREFIX;
     }

Here is the caller graph for this function: