ilUDFDefinitionPlugin Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUDFDefinitionPlugin:

Collaboration diagram for ilUDFDefinitionPlugin:

Public Member Functions
	getDefinitionType ()
	getDefinitionTypeName ()
	addDefinitionTypeOptionsToRadioOption (ilRadioOption $option, int $field_id)
	Add udf type options to radio option. More...
	getDefinitionUpdateFormTitle ()
	get title for update form More...
	updateDefinitionFromForm (ilPropertyFormGUI $form, int $a_definition_id)
	Update definition from form input. More...
	getFormPropertyForDefinition (array $definition, bool $a_changeable=true, ?string $a_default_value=null)
	Context: edit user; registration; edit user profile. More...
	lookupUserData (array $a_user_ids, array $a_field_ids)
	If user data data is not stored in table udf_text, return an array with user data for each udf field [ USER_ID => ['FIELD_ID' => custom_value] ]. More...
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...

Data Fields
const	UDF_SLOT_ID = 'udfd'

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning UDF type definition plugin

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Member Function Documentation

addDefinitionTypeOptionsToRadioOption()

ilUDFDefinitionPlugin::addDefinitionTypeOptionsToRadioOption ( ilRadioOption  $option, int  $field_id  )

abstract

Add udf type options to radio option.

getDefinitionType()

ilUDFDefinitionPlugin::getDefinitionType ( )

abstract

getDefinitionTypeName()

ilUDFDefinitionPlugin::getDefinitionTypeName ( )

abstract

getDefinitionUpdateFormTitle()

ilUDFDefinitionPlugin::getDefinitionUpdateFormTitle ( )

abstract

get title for update form

getFormPropertyForDefinition()

ilUDFDefinitionPlugin::getFormPropertyForDefinition ( array  $definition, bool  $a_changeable = true, ?string  $a_default_value = null  )

abstract

Context: edit user; registration; edit user profile.

lookupUserData()

ilUDFDefinitionPlugin::lookupUserData ( array  $a_user_ids, array  $a_field_ids  )

abstract

If user data data is not stored in table udf_text, return an array with user data for each udf field [ USER_ID => ['FIELD_ID' => custom_value] ].

updateDefinitionFromForm()

ilUDFDefinitionPlugin::updateDefinitionFromForm ( ilPropertyFormGUI  $form, int  $a_definition_id  )

abstract

Update definition from form input.

Field Documentation

UDF_SLOT_ID

const ilUDFDefinitionPlugin::UDF_SLOT_ID = 'udfd'

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

Referenced by ilCustomUserFieldsHelper\getActivePlugins().

---

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

• Services/User/classes/class.ilUDFDefinitionPlugin.php