ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilUDFDefinitionPlugin Class Reference

UDF type deefinition plugin. More...

+ Inheritance diagram for ilUDFDefinitionPlugin:
+ Collaboration diagram for ilUDFDefinitionPlugin:

Public Member Functions

 getDefinitionType ()
 Get udf type. More...
 
 getDefinitionTypeName ()
 Get udf type name. More...
 
 addDefinitionTypeOptionsToRadioOption (ilRadioOption $option, $field_id)
 Add udf type options to radio option. More...
 
 getDefinitionUpdateFormTitle ()
 get title for update form More...
 
 updateDefinitionFromForm (ilPropertyFormGUI $form, $a_definition_id)
 Update definition from form input. More...
 
 getFormPropertyForDefinition ($definition, $a_default_value=null)
 Get form property for definition Context: edit user; registration; edit user profile. More...
 
 lookupUserData ($a_user_ids, $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...
 
 getComponentName ()
 Get component name. More...
 
 getComponentType ()
 get component type More...
 
 getSlot ()
 Get slot. More...
 
 getSlotId ()
 Get slot id. More...
 
 slotInit ()
 implemented 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 ()
 
 getLastUpdateVersion ()
 Get Version of last update. More...
 
 getVersion ()
 
 getIliasMinVersion ()
 
 getIliasMaxVersion ()
 Get Required ILIAS max. More...
 
 getActive ()
 
 setDBVersion (int $a_dbversion)
 
 getDBVersion ()
 
 writeDBVersion (int $a_dbversion)
 
 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 (string $a_var)
 Get Language Variable (prefix will be prepended automatically) More...
 
 getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
 gets a ilTemplate instance of a html-file in the plugin /templates More...
 
 getImagePath (string $a_img)
 Get image path. More...
 
 getStyleSheetLocation (string $a_css_file)
 
 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 ()
 
 activate ()
 Activate. More...
 
 deactivate ()
 Deactivate. More...
 
 uninstall ()
 
 update ()
 Update plugin. More...
 
 promoteGlobalScreenProvider ()
 

Data Fields

const UDF_SLOT = 'UDFDefinition'
 
const UDF_SLOT_ID = 'udfd'
 
const UDF_C_NAME = 'User'
 
const UDF_C_TYPE = IL_COMP_SERVICE
 

Additional Inherited Members

- Static Public Member Functions inherited from ilPlugin
static _getDirectory (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
 Get plugin directory. More...
 
static getAvailableLangFiles (string $a_lang_directory)
 Get array of all language files in the plugin. More...
 
static hasConfigureClass (string $a_slot_dir, array $plugin_data, array $plugin_db_data)
 Has the plugin a configure class? More...
 
static getConfigureClassName (array $plugin_data)
 Get plugin configure class name. More...
 
static getDBUpdateScriptName (string $a_ctype, string $a_cname, string $a_slot_name, string $a_pname)
 
static lookupTxt (string $a_mod_prefix, string $a_pl_id, string $a_lang_var)
 
static langExitsById (string $pluginId, string $langVar)
 Is searched lang var available in plugin lang files. More...
 
static _getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img)
 
static createPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
 
static getPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
 
static getPluginObject (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
 
static lookupStoredData (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
 Lookup information data in il_plugin. More...
 
static getActivePluginsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)
 
static getActivePluginIdsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)
 Get All active plugin ids for a slot. More...
 
static lookupNameForId (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_id)
 
static lookupIdForName (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_name)
 
static lookupTypeInformationsForId (string $id)
 
- Protected Member Functions inherited from ilPlugin
 setSlotObject (ilPluginSlot $a_slot)
 
 getSlotObject ()
 
 getClassesDirectory ()
 
 getLanguageDirectory ()
 
 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 ()
 This is Plugin-Specific and is triggered after the uninstall command of a plugin. More...
 
 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...
 
- Protected Attributes inherited from ilPlugin
 $slot
 
 $active = false
 
 $iliasmaxversion = ""
 
 $iliasminversion = ""
 
 $version = ""
 
 $lastupdateversion = ""
 
 $dbversion = 0
 
 $lang_initialised = false
 
 $id = ''
 

Detailed Description

UDF type deefinition plugin.

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

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

Member Function Documentation

◆ addDefinitionTypeOptionsToRadioOption()

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

Add udf type options to radio option.

◆ getComponentName()

ilUDFDefinitionPlugin::getComponentName ( )
final

Get component name.

Returns
string

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

73  {
74  return self::UDF_C_NAME;
75  }

◆ getComponentType()

ilUDFDefinitionPlugin::getComponentType ( )
final

get component type

Returns
string

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

82  {
83  return self::UDF_C_TYPE;
84  }

◆ getDefinitionType()

ilUDFDefinitionPlugin::getDefinitionType ( )
abstract

Get udf type.

◆ getDefinitionTypeName()

ilUDFDefinitionPlugin::getDefinitionTypeName ( )
abstract

Get udf type name.

◆ getDefinitionUpdateFormTitle()

ilUDFDefinitionPlugin::getDefinitionUpdateFormTitle ( )
abstract

get title for update form

◆ getFormPropertyForDefinition()

ilUDFDefinitionPlugin::getFormPropertyForDefinition (   $definition,
  $a_default_value = null 
)
abstract

Get form property for definition Context: edit user; registration; edit user profile.

Returns
ilFormPropertyGUI

◆ getSlot()

ilUDFDefinitionPlugin::getSlot ( )

Get slot.

Returns
string

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

92  {
93  return self::UDF_SLOT;
94  }

◆ getSlotId()

ilUDFDefinitionPlugin::getSlotId ( )

Get slot id.

Returns
string

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

101  {
102  return self::UDF_SLOT_ID;
103  }

◆ lookupUserData()

ilUDFDefinitionPlugin::lookupUserData (   $a_user_ids,
  $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] ].

Returns
array

◆ slotInit()

ilUDFDefinitionPlugin::slotInit ( )

implemented

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

109  {
110  }

◆ updateDefinitionFromForm()

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

Update definition from form input.

Field Documentation

◆ UDF_C_NAME

const ilUDFDefinitionPlugin::UDF_C_NAME = 'User'

◆ UDF_C_TYPE

const ilUDFDefinitionPlugin::UDF_C_TYPE = IL_COMP_SERVICE

◆ UDF_SLOT

const ilUDFDefinitionPlugin::UDF_SLOT = 'UDFDefinition'

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

◆ UDF_SLOT_ID

const ilUDFDefinitionPlugin::UDF_SLOT_ID = 'udfd'

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