ILIAS  release_7 Revision v7.30-3-g800a261c036
class.ilUDFDefinitionPlugin.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
4
5include_once './Services/Component/classes/class.ilPlugin.php';
6
13abstract class ilUDFDefinitionPlugin extends ilPlugin
14{
15 const UDF_SLOT = 'UDFDefinition';
16 const UDF_SLOT_ID = 'udfd';
17 const UDF_C_NAME = 'User';
19
20
21
22
26 abstract public function getDefinitionType();
27
31 abstract public function getDefinitionTypeName();
32
36 abstract public function addDefinitionTypeOptionsToRadioOption(ilRadioOption $option, $field_id);
37
41 abstract public function getDefinitionUpdateFormTitle();
42
46 abstract public function updateDefinitionFromForm(ilPropertyFormGUI $form, $a_definition_id);
47
53 abstract public function getFormPropertyForDefinition($definition, $a_default_value = null);
54
55
65 abstract public function lookupUserData($a_user_ids, $a_field_ids);
66
67
72 final public function getComponentName()
73 {
74 return self::UDF_C_NAME;
75 }
76
81 final public function getComponentType()
82 {
83 return self::UDF_C_TYPE;
84 }
85
86
91 public function getSlot()
92 {
93 return self::UDF_SLOT;
94 }
95
100 public function getSlotId()
101 {
102 return self::UDF_SLOT_ID;
103 }
104
108 public function slotInit()
109 {
110 }
111}
An exception for terminatinating execution or to throw for unit testing.
const IL_COMP_SERVICE
Abstract Class ilPlugin.
This class represents a property form user interface.
This class represents an option in a radio group.
UDF type deefinition plugin.
getComponentType()
get component type
getDefinitionUpdateFormTitle()
get title for update form
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 ...
addDefinitionTypeOptionsToRadioOption(ilRadioOption $option, $field_id)
Add udf type options to radio option.
getDefinitionType()
Get udf type.
getDefinitionTypeName()
Get udf type name.
getFormPropertyForDefinition($definition, $a_default_value=null)
Get form property for definition Context: edit user; registration; edit user profile.
updateDefinitionFromForm(ilPropertyFormGUI $form, $a_definition_id)
Update definition from form input.
getComponentName()
Get component name.