ILIAS  trunk Revision v5.2.0beta1-34115-g3a2438be29
ilAdvancedMDFieldDefinitionFloat Class Reference

AMD field type float (based on integer) More...

+ Inheritance diagram for ilAdvancedMDFieldDefinitionFloat:
+ Collaboration diagram for ilAdvancedMDFieldDefinitionFloat:

Public Member Functions

 __construct (GenericData $generic_data, string $language='')
 
 getType ()
 
 isFilterSupported ()
 
 setDecimals ($a_value)
 Set decimals. More...
 
 getDecimals ()
 Get decimals. More...
 
 getFieldDefinitionForTableGUI (string $content_language)
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
 Import custom post values from definition form. More...
 
 importXMLProperty (string $a_key, string $a_value)
 
- Public Member Functions inherited from ilAdvancedMDFieldDefinitionInteger
 getType ()
 
 isFilterSupported ()
 
 getSuffixTranslations ()
 
 setSuffixTranslation (string $language, string $suffix)
 
 setSuffixTranslations (array $suffix_translations)
 
 setMin (?int $a_value)
 
 getMin ()
 
 setMax (?int $a_value)
 
 getMax ()
 
 setSuffix (?string $a_value)
 
 getSuffix ()
 
 getFieldDefinitionForTableGUI (string $content_language)
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
 
 importXMLProperty (string $a_key, string $a_value)
 
 getValueForXML (ilADT $element)
 
 importValueFromXML (string $a_cdata)
 
- Public Member Functions inherited from ilAdvancedMDFieldDefinition
 __construct (GenericData $generic_data, string $language='')
 
 getType ()
 Get type. More...
 
 useDefaultLanguageMode (string $language)
 Check if default language mode has to be used: no language given or language equals default language. More...
 
 getTypeTitle ()
 
 getADTDefinition ()
 Get ADT definition instance. More...
 
 getADT ()
 
 getFieldId ()
 Get field_id. More...
 
 setRecordId (int $a_id)
 Set record id. More...
 
 getRecordId ()
 Get record id. More...
 
 setImportId (string $a_id_string)
 Set import id. More...
 
 getImportId ()
 Get import id. More...
 
 setPosition (int $a_pos)
 Set position. More...
 
 getPosition ()
 Get position. More...
 
 setTitle (string $a_title)
 Get title. More...
 
 getTitle ()
 Get title. More...
 
 setDescription (string $a_desc)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 isSearchSupported ()
 Is search supported at all. More...
 
 isFilterSupported ()
 Is search by filter supported. More...
 
 setSearchable (bool $a_status)
 Toggle searchable. More...
 
 isSearchable ()
 Is searchable. More...
 
 setRequired (bool $a_status)
 Toggle required. More...
 
 isRequired ()
 Is required field. More...
 
 getFieldDefinitionForTableGUI (string $content_language)
 Parse properties for table gui. More...
 
 addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $language='')
 Add input elements to definition form. More...
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')
 Import custom post values from definition form. More...
 
 importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $active_language)
 Import post values from definition form. More...
 
 importDefinitionFormPostValuesNeedsConfirmation ()
 
 prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
 
 prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
 
 generateImportId (int $a_field_id)
 Generate unique record id. More...
 
 save (bool $a_keep_pos=false)
 Create new field entry. More...
 
 update ()
 Update field entry. More...
 
 delete ()
 Delete field entry. More...
 
 toXML (ilXmlWriter $a_writer)
 To Xml. More...
 
 importXMLProperty (string $a_key, string $a_value)
 Import property from XML. More...
 
 getValueForXML (ilADT $element)
 Parse ADT value for xml (export) More...
 
 importValueFromXML (string $a_cdata)
 Import value from xml. More...
 
 importFromECS (string $a_ecs_type, $a_value, string $a_sub_id)
 Import meta data from ECS. More...
 
 prepareElementForEditor (ilADTFormBridge $a_bridge)
 Prepare editor form elements. More...
 
 getSearchQueryParserValue (ilADTSearchBridge $a_adt_search)
 Get value for search query parser. More...
 
 getSearchValueSerialized (ilADTSearchBridge $a_adt_search)
 
 setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
 Set value from search persistence. More...
 
 searchSubObjects (ilADTSearchBridge $a_adt_search, int $a_obj_id, string $sub_obj_type)
 
 searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, string $a_locate, string $a_search_type)
 Search objects. More...
 
 getLuceneSearchString ($a_value)
 Get search string in lucene syntax. More...
 
 prepareElementForSearch (ilADTSearchBridge $a_bridge)
 Prepare search form elements. More...
 
 _clone (int $a_new_record_id)
 Clone field definition. More...
 
 hasComplexOptions ()
 
 getComplexOptionsOverview (object $a_parent_gui, string $parent_cmd)
 

Protected Member Functions

 init ()
 
 initADTDefinition ()
 
 importFieldDefinition (array $a_def)
 
 getFieldDefinition ()
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
 Add input elements to definition form. More...
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 
- Protected Member Functions inherited from ilAdvancedMDFieldDefinitionInteger
 initADTDefinition ()
 
 importFieldDefinition (array $a_def)
 
 getFieldDefinition ()
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 
- Protected Member Functions inherited from ilAdvancedMDFieldDefinition
 initADTDefinition ()
 Init adt instance. More...
 
 setADT (ilADT $a_adt)
 Set ADT instance. More...
 
 importFieldDefinition (array $a_def)
 Import (type-specific) field definition from DB. More...
 
 getFieldDefinition ()
 Get (type-specific) field definition. More...
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
 Add custom input elements to definition form. More...
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 Add (type-specific) properties to xml export. More...
 
 parseSearchObjects (array $a_records, array $a_object_types)
 Add object-data needed for global search to AMD search results. More...
 

Protected Attributes

int $decimals
 
- Protected Attributes inherited from ilAdvancedMDFieldDefinitionInteger
int $min = null
 
int $max = null
 
string $suffix = null
 
 $suffix_translations = []
 
- Protected Attributes inherited from ilAdvancedMDFieldDefinition
GenericData $generic_data
 
ilADTDefinition $adt_def = null
 
ilADT $adt = null
 
string $language = ''
 
ilDBInterface $db
 
ilLanguage $lng
 
ilLogger $logger
 
GlobalHttpState $http
 
RefineryFactory $refinery
 

Additional Inherited Members

- Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static getInstance (?int $a_field_id, ?int $a_type=null, string $language='')
 
static exists (int $a_field_id)
 
static getInstanceByTypeString (string $a_type)
 Get instance by type string (used by import) More...
 
static getInstancesByRecordId ( $a_record_id, $a_only_searchable=false, string $language='')
 Get definitions by record id. More...
 
static getInstancesByObjType ($a_obj_type, $a_active_only=true)
 
static getInstanceByImportId (string $a_import_id)
 
static getSearchableDefinitionIds ()
 Get searchable definition ids (performance is key) More...
 
static getADTGroupForDefinitions (array $a_defs)
 Init ADTGroup for definitions. More...
 
static getValidTypes ()
 Get all valid types. More...
 
static isValidType (int $a_type)
 
- Data Fields inherited from ilAdvancedMDFieldDefinition
const TYPE_SELECT = 1
 TODO: put this in when minimum php version is set to 8.2. More...
 
const TYPE_TEXT = 2
 
const TYPE_DATE = 3
 
const TYPE_DATETIME = 4
 
const TYPE_INTEGER = 5
 
const TYPE_FLOAT = 6
 
const TYPE_LOCATION = 7
 
const TYPE_SELECT_MULTI = 8
 
const TYPE_ADDRESS = 99
 
const TYPE_EXTERNAL_LINK = 9
 
const TYPE_INTERNAL_LINK = 10
 
- Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static getInstanceWithData (GenericData $generic_data, string $language='')
 
static getTypeString (int $a_type)
 Get type as string. More...
 

Detailed Description

AMD field type float (based on integer)

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDFieldDefinitionFloat::__construct ( GenericData  $generic_data,
string  $language = '' 
)

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinitionFloat::addCustomFieldToDefinitionForm ( ilPropertyFormGUI  $a_form,
bool  $a_disabled = false,
string  $language = '' 
)
protected

Add input elements to definition form.

Parameters
ilPropertyFormGUI$a_form
bool$a_disabled
string$language

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

References $DIC, ilAdvancedMDFieldDefinition\$language, ilAdvancedMDFieldDefinition\$lng, ilPropertyFormGUI\addItem(), getDecimals(), and ilLanguage\txt().

106  : void {
107  global $DIC;
108 
109  $lng = $DIC['lng'];
110 
111  // #32
112  parent::addCustomFieldToDefinitionForm($a_form, $a_disabled, $language);
113 
114  $decimals = new ilNumberInputGUI($lng->txt("md_adv_number_decimals"), "dec");
115  $decimals->setRequired(true);
116  $decimals->setValue((string) $this->getDecimals());
117  $decimals->setSize(5);
118  $a_form->addItem($decimals);
119 
120  if ($a_disabled) {
121  $decimals->setDisabled(true);
122  }
123  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
$DIC
Definition: xapitoken.php:62
+ Here is the call graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionFloat::addPropertiesToXML ( ilXmlWriter  $a_writer)
protected

Definition at line 139 of file class.ilAdvancedMDFieldDefinitionFloat.php.

References getDecimals(), and ilXmlWriter\xmlElement().

139  : void
140  {
141  parent::addPropertiesToXML($a_writer);
142  $a_writer->xmlElement('FieldValue', array("id" => "decimals"), $this->getDecimals());
143  }
xmlElement(string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
Writes a basic element (no children, just textual content)
+ Here is the call graph for this function:

◆ getDecimals()

ilAdvancedMDFieldDefinitionFloat::getDecimals ( )

Get decimals.

Returns
int

Definition at line 62 of file class.ilAdvancedMDFieldDefinitionFloat.php.

References $decimals.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), getFieldDefinition(), getFieldDefinitionForTableGUI(), and initADTDefinition().

+ Here is the caller graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinition ( )
protected

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

References getDecimals().

78  : array
79  {
80  $def = parent::getFieldDefinition();
81  $def["decimals"] = $this->getDecimals();
82  return $def;
83  }
+ Here is the call graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinitionForTableGUI ( string  $content_language)

Definition at line 85 of file class.ilAdvancedMDFieldDefinitionFloat.php.

References $DIC, ilAdvancedMDFieldDefinition\$lng, $res, getDecimals(), and ilLanguage\txt().

85  : array
86  {
87  global $DIC;
88 
89  $lng = $DIC['lng'];
90 
91  $res = parent::getFieldDefinitionForTableGUI($content_language);
92  $res[$lng->txt("md_adv_number_decimals")] = $this->getDecimals();
93  return $res;
94  }
$res
Definition: ltiservices.php:67
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
$DIC
Definition: xapitoken.php:62
+ Here is the call graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionFloat::getType ( )

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

23  : int
24  {
25  return self::TYPE_FLOAT;
26  }

◆ importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionFloat::importCustomDefinitionFormPostValues ( ilPropertyFormGUI  $a_form,
string  $language = '' 
)

Import custom post values from definition form.

Definition at line 128 of file class.ilAdvancedMDFieldDefinitionFloat.php.

References ilAdvancedMDFieldDefinition\$language, ilPropertyFormGUI\getInput(), and setDecimals().

128  : void
129  {
130  parent::importCustomDefinitionFormPostValues($a_form, $language);
131  $this->setDecimals((int) $a_form->getInput("dec"));
132  }
getInput(string $a_post_var, bool $ensureValidation=true)
Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-...
+ Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::importFieldDefinition ( array  $a_def)
protected

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

References setDecimals().

72  : void
73  {
74  parent::importFieldDefinition($a_def);
75  $this->setDecimals($a_def["decimals"]);
76  }
+ Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionFloat::importXMLProperty ( string  $a_key,
string  $a_value 
)

Definition at line 145 of file class.ilAdvancedMDFieldDefinitionFloat.php.

References setDecimals().

145  : void
146  {
147  if ($a_key == "decimals") {
148  $this->setDecimals($a_value != "" ? $a_value : null);
149  }
150 
151  parent::importXMLProperty($a_key, $a_value);
152  }
+ Here is the call graph for this function:

◆ init()

ilAdvancedMDFieldDefinitionFloat::init ( )
protected

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

References setDecimals().

Referenced by __construct().

28  : void
29  {
30  $this->setDecimals(2);
31  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionFloat::initADTDefinition ( )
protected

Definition at line 38 of file class.ilAdvancedMDFieldDefinitionFloat.php.

References getDecimals(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinitionInteger\getMax(), ilAdvancedMDFieldDefinitionInteger\getMin(), ilAdvancedMDFieldDefinitionInteger\getSuffix(), ilAdvancedMDFieldDefinitionInteger\getSuffixTranslations(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

39  {
40  $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Float");
41 
42  $def->setMin($this->getMin());
43  $def->setMax($this->getMax());
44  $def->setDecimals($this->getDecimals());
45  $def->setSuffix($this->getSuffixTranslations()[$this->language] ?? $this->getSuffix());
46  return $def;
47  }
ADT definition base class.
+ Here is the call graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinitionFloat::isFilterSupported ( )

Definition at line 33 of file class.ilAdvancedMDFieldDefinitionFloat.php.

33  : bool
34  {
35  return false;
36  }

◆ setDecimals()

ilAdvancedMDFieldDefinitionFloat::setDecimals (   $a_value)

Set decimals.

Parameters
int$a_value

Definition at line 53 of file class.ilAdvancedMDFieldDefinitionFloat.php.

Referenced by importCustomDefinitionFormPostValues(), importFieldDefinition(), importXMLProperty(), and init().

54  {
55  $this->decimals = max(1, abs((int) $a_value));
56  }
+ Here is the caller graph for this function:

Field Documentation

◆ $decimals

int ilAdvancedMDFieldDefinitionFloat::$decimals
protected

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

Referenced by getDecimals().


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