ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilAdvancedMDFieldDefinitionFloat Class Reference

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

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

Public Member Functions

 getType ()
 Get type. More...
 
 isFilterSupported ()
 Is search by filter supported. More...
 
 setDecimals ($a_value)
 Set decimals. More...
 
 getDecimals ()
 Get decimals. More...
 
 getFieldDefinitionForTableGUI ()
 Parse properties for table gui. More...
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false)
 Add input elements to definition form. More...
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
 Import custom post values from definition form. More...
 
 importXMLProperty ($a_key, $a_value)
 Import property from XML. More...
 
- Public Member Functions inherited from ilAdvancedMDFieldDefinitionInteger
 getType ()
 Get type. More...
 
 isFilterSupported ()
 Is search by filter supported. More...
 
 setMin ($a_value)
 Set min. More...
 
 getMin ()
 Get min. More...
 
 setMax ($a_value)
 Set max. More...
 
 getMax ()
 Get max. More...
 
 setSuffix ($a_value)
 Set suffix. More...
 
 getSuffix ()
 Get suffix. More...
 
 getFieldDefinitionForTableGUI ()
 Parse properties for table gui. More...
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false)
 Add input elements to definition form. More...
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
 Import custom post values from definition form. More...
 
 importXMLProperty ($a_key, $a_value)
 Import property from XML. More...
 
 getValueForXML (ilADT $element)
 Parse ADT value for xml (export) More...
 
 importValueFromXML ($a_cdata)
 Import value from xml. More...
 
- Public Member Functions inherited from ilAdvancedMDFieldDefinition
 __construct ($a_field_id=null)
 Constructor. More...
 
 getType ()
 Get type. More...
 
 getTypeTitle ()
 Get type title (lang id) More...
 
 getADTDefinition ()
 Get ADT definition instance. More...
 
 getADT ()
 Get ADT instance. More...
 
 getFieldId ()
 Get field_id. More...
 
 setRecordId ($a_id)
 Set record id. More...
 
 getRecordId ()
 Get record id. More...
 
 setImportId ($a_id_string)
 Set import id. More...
 
 getImportId ()
 Get import id. More...
 
 setPosition ($a_pos)
 Set position. More...
 
 getPosition ()
 Get position. More...
 
 setTitle ($a_title)
 Get title. More...
 
 getTitle ()
 Get title. More...
 
 setDescription ($a_desc)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 isSearchSupported ()
 Is search supported at all. More...
 
 isFilterSupported ()
 Is search by filter supported. More...
 
 setSearchable ($a_status)
 Toggle searchable. More...
 
 isSearchable ()
 Is searchable. More...
 
 setRequired ($a_status)
 Toggle required. More...
 
 isRequired ()
 Is required field. More...
 
 getFieldDefinitionForTableGUI ()
 Parse properties for table gui. More...
 
 addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
 Add input elements to definition form. More...
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
 Import custom post values from definition form. More...
 
 importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
 Import post values from definition form. More...
 
 importDefinitionFormPostValuesNeedsConfirmation ()
 
 prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
 
 prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
 
 generateImportId ($a_field_id)
 Generate unique record id. More...
 
 save ()
 Create new field entry. More...
 
 update ()
 Update field entry. More...
 
 delete ()
 Delete field entry. More...
 
 toXML (ilXmlWriter $a_writer)
 To Xml. More...
 
 importXMLProperty ($a_key, $a_value)
 Import property from XML. More...
 
 getValueForXML (ilADT $element)
 Parse ADT value for xml (export) More...
 
 importValueFromXML ($a_cdata)
 Import value from xml. More...
 
 importFromECS ($a_ecs_type, $a_value, $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)
 Get value for search persistence. More...
 
 setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
 Set value from search persistence. More...
 
 searchSubObjects (ilADTSearchBridge $a_adt_search, $a_obj_id, $sub_obj_type)
 
 searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $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...
 

Protected Member Functions

 init ()
 Init properties. More...
 
 initADTDefinition ()
 Init adt instance. More...
 
 importFieldDefinition (array $a_def)
 Import (type-specific) field definition from DB. More...
 
 getFieldDefinition ()
 Get (type-specific) field definition. More...
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 Add (type-specific) properties to xml export. More...
 
 initADTDefinition ()
 Init adt instance. More...
 
 importFieldDefinition (array $a_def)
 Import (type-specific) field definition from DB. More...
 
 getFieldDefinition ()
 Get (type-specific) field definition. More...
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 Add (type-specific) properties to xml export. More...
 
- Protected Member Functions inherited from ilAdvancedMDFieldDefinition
 init ()
 Init properties. More...
 
 initADTDefinition ()
 Init adt instance. More...
 
 setADT (ilADT $a_adt)
 Set ADT instance. More...
 
 setFieldId ($a_id)
 Set field_id. More...
 
 importFieldDefinition (array $a_def)
 Import (type-specific) field definition from DB. More...
 
 getFieldDefinition ()
 Get (type-specific) field definition. More...
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false)
 Add custom input elements to definition form. More...
 
 getLastPosition ()
 Get last position of record. More...
 
 getDBProperties ()
 Get all definition properties for DB. More...
 
 import (array $a_data)
 Import from DB. More...
 
 read ($a_field_id)
 Read field definition
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

 $decimals
 
- Protected Attributes inherited from ilAdvancedMDFieldDefinitionInteger
 $min
 
 $max
 
 $suffix
 
- Protected Attributes inherited from ilAdvancedMDFieldDefinition
 $field_id
 
 $record_id
 
 $import_id
 
 $position
 
 $title
 
 $description
 
 $searchable
 
 $required
 
 $adt_def
 
 $adt
 

Additional Inherited Members

- Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static getInstance ($a_field_id, $a_type=null)
 Get definition instance by type. More...
 
static getInstanceByTypeString ($a_type)
 Get instance by type string (used by import) More...
 
static getInstancesByRecordId ($a_record_id, $a_only_searchable=false)
 Get definitions by record id. More...
 
static getInstancesByObjType ($a_obj_type, $a_active_only=true)
 
static getInstanceByImportId ($a_import_id)
 Get definition instance by import id. More...
 
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 ($a_type)
 Is given type valid. More...
 
- Data Fields inherited from ilAdvancedMDFieldDefinition
const TYPE_SELECT = 1
 
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
 
- Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static getTypeString ($a_type)
 Get type 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
Version
$Id$

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

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinitionFloat::addCustomFieldToDefinitionForm ( ilPropertyFormGUI  $a_form,
  $a_disabled = false 
)

Add input elements to definition form.

Parameters
ilPropertyFormGUI$a_form
bool$a_disabled

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

114 {
115 global $lng;
116
117 // #32
118 parent::addCustomFieldToDefinitionForm($a_form, $a_disabled);
119
120 $decimals = new ilNumberInputGUI($lng->txt("md_adv_number_decimals"), "dec");
121 $decimals->setRequired(true);
122 $decimals->setValue($this->getDecimals());
123 $decimals->setSize(5);
124 $a_form->addItem($decimals);
125
126 if($a_disabled)
127 {
128 $decimals->setDisabled(true);
129 }
130 }
This class represents a number property in a property form.
addItem($a_item)
Add Item (Property, SectionHeader).
global $lng
Definition: privfeed.php:40

References $decimals, $lng, ilPropertyFormGUI\addItem(), and getDecimals().

+ Here is the call graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionFloat::addPropertiesToXML ( ilXmlWriter  $a_writer)
protected

Add (type-specific) properties to xml export.

Parameters
ilXmlWriter$a_writer

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

150 {
151 parent::addPropertiesToXML($a_writer);
152
153 $a_writer->xmlElement('FieldValue',array("id"=>"decimals"),$this->getDecimals());
154 }
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)

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

+ Here is the call graph for this function:

◆ getDecimals()

ilAdvancedMDFieldDefinitionFloat::getDecimals ( )

Get decimals.

Returns
int

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

76 {
77 return $this->decimals;
78 }

References $decimals.

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

+ Here is the caller graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinition ( )
protected

Get (type-specific) field definition.

Returns
array

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

92 {
93 $def = parent::getFieldDefinition();
94 $def["decimals"] = $this->getDecimals();
95 return $def;
96 }

References getDecimals().

+ Here is the call graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionFloat::getFieldDefinitionForTableGUI ( )

Parse properties for table gui.

Returns
array

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

99 {
100 global $lng;
101
102 $res = parent::getFieldDefinitionForTableGUI();
103 $res[$lng->txt("md_adv_number_decimals")] = $this->getDecimals();
104 return $res;
105 }

References $lng, $res, and getDecimals().

+ Here is the call graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionFloat::getType ( )

◆ importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionFloat::importCustomDefinitionFormPostValues ( ilPropertyFormGUI  $a_form)

Import custom post values from definition form.

Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

138 {
139 parent::importCustomDefinitionFormPostValues($a_form);
140
141 $this->setDecimals($a_form->getInput("dec"));
142 }
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.

References ilPropertyFormGUI\getInput(), and setDecimals().

+ Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionFloat::importFieldDefinition ( array  $a_def)
protected

Import (type-specific) field definition from DB.

Parameters
array$a_def

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

86 {
87 parent::importFieldDefinition($a_def);
88 $this->setDecimals($a_def["decimals"]);
89 }

References setDecimals().

+ Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionFloat::importXMLProperty (   $a_key,
  $a_value 
)

Import property from XML.

Parameters
string$a_key
string$a_value

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

157 {
158 if($a_key == "decimals")
159 {
160 $this->setDecimals($a_value != "" ? $a_value : null);
161 }
162
163 parent::importXMLProperty($a_key, $a_value);
164 }

References setDecimals().

+ Here is the call graph for this function:

◆ init()

ilAdvancedMDFieldDefinitionFloat::init ( )
protected

Init properties.

Reimplemented from ilAdvancedMDFieldDefinition.

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

28 {
29 parent::init();
30 $this->setDecimals(2);
31 }

References setDecimals().

+ Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionFloat::initADTDefinition ( )
protected

Init adt instance.

Returns
ilADTDefinition

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

44 {
45 $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Float");
46
47 $def->setMin($this->getMin());
48 $def->setMax($this->getMax());
49 $def->setDecimals($this->getDecimals());
50 $def->setSuffix($this->getSuffix());
51
52 return $def;
53 }
static getInstance()
Get singleton.

References getDecimals(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinitionInteger\getMax(), ilAdvancedMDFieldDefinitionInteger\getMin(), and ilAdvancedMDFieldDefinitionInteger\getSuffix().

+ Here is the call graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinitionFloat::isFilterSupported ( )

Is search by filter supported.

Returns
boolean

Reimplemented from ilAdvancedMDFieldDefinitionInteger.

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

34 {
35 return false;
36 }

◆ setDecimals()

ilAdvancedMDFieldDefinitionFloat::setDecimals (   $a_value)

Set decimals.

Parameters
int$a_value

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

66 {
67 $this->decimals = max(1, abs((int)$a_value));
68 }

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

+ Here is the caller graph for this function:

Field Documentation

◆ $decimals

ilAdvancedMDFieldDefinitionFloat::$decimals
protected

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