Added a comment explaining the purpose of safe functions.

[timetracker.git] / WEB-INF / lib / form / FormElement.class.php

diff --git a/WEB-INF/lib/form/FormElement.class.php b/WEB-INF/lib/form/FormElement.class.php
index 20fdb07e9a97b395c7ac787b61798c0c9f0956a4..cf43b8d0512c1ec6aa30d298bffe06f0fd4727e8 100644 (file)
--- a/WEB-INF/lib/form/FormElement.class.php
+++ b/WEB-INF/lib/form/FormElement.class.php
@@ -39,28 +39,28 @@ class FormElement {
   var $label = '';      // Optional label for control.
   var $style = '';      // Control style.
   var $enabled = true;  // Whether the control is enabled.
-        
-  // TODO: refactoring ongoing down from here.
-       var $cClassName         = "FormElement";
-       var $mI18n                      = null;
+  var $class = 'FormElement'; // Class name for the element.
 
-       function __construct() {
-       }
+  function __construct() {
+  }
 
-       function getClass()     { return $this->cClassName; }
-       
-       function setName($name) { $this->name = $name; }
-       function getName()      { return $this->name; }
-       
-       function setFormName($name) { $this->form_name = $name; }
-       function getFormName()  { return $this->form_name; }
-       
-       function setValue($value) { $this->value = $value;}
-       function getValue() { return $this->value; }
-       
-       function setValueSafe($value) { $this->value = $value;}
-       function getValueSafe() { return $this->value; }
+  function getName() { return $this->name; }
+  function getClass() { return $this->class; }
 
+  function setFormName($name) { $this->form_name = $name; }
+  function getFormName() { return $this->form_name; }
+
+  function setValue($value) { $this->value = $value; }
+  function getValue() { return $this->value; }
+
+  // Safe function variations are used to store/read values in/from user session for further reuse.
+  // They may convert data in derived classes to some standard form. For example, floats are stored
+  // with a dot delimiter (not comma), and dates are stored in DB_DATEFORMAT.
+  // This allows to reuse data in session even when user changes the deliminter or date format.
+  function setValueSafe($value) { $this->value = $value;}
+  function getValueSafe() { return $this->value; }
+
+  // TODO: refactoring ongoing down from here.
        function setId($id) { $this->id = $id;  }
        function getId() { return $this->id; }
        
@@ -83,8 +83,7 @@ class FormElement {
        function setOnClick($str) { $this->on_click = $str; }
 
        function setLocalization($i18n) {
-               $this->mI18n = $i18n;
-       }
+        }
        
        function toStringControl()      {
                return "";