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 6bdca866cafb12ae0c406a649e0d120f2d33bc27..cf43b8d0512c1ec6aa30d298bffe06f0fd4727e8 100644 (file)
--- a/WEB-INF/lib/form/FormElement.class.php
+++ b/WEB-INF/lib/form/FormElement.class.php
@@ -28,77 +28,69 @@
 
 // FromElement is the base class for controls on forms.
 class FormElement {
-  var $id = '';
-  var $name;
-  var $form_name = '';
-  var $value = '';
-  var $size = '';
-  var $max_length = '';
-  // TODO: refactoring ongoing down from here.
-       var $mOnSelect          = "";
-       var $mOnChange          = "";
-       var $mOnClick           = "";
-       var $mOnKeyPress        = "";
-       var $mOnFocus           = "";
-       var $mLabel         = "";
-       var $mStyle         = "";
-       var $mRenderable    = true;
-       var $mEnabled           = true;
-       var $cClassName         = "FormElement";
-       var $mI18n                      = null;
+  var $id = '';         // Control id.
+  var $name;            // Control name.
+  var $form_name = '';  // Form name the control is in.
+  var $value = '';      // Value of the control.
+  var $size = '';       // Control size.
+  var $max_length = ''; // Max length of text in control.
+  var $on_change = '';  // What happens when value of control changes.
+  var $on_click = '';   // What happens when the control is clicked.
+  var $label = '';      // Optional label for control.
+  var $style = '';      // Control style.
+  var $enabled = true;  // Whether the control is enabled.
+  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; }
        
        function setSize($value) { $this->size = $value; }
        function getSize() { return $this->size; }
 
-       function setLabel($label)       { $this->mLabel = $label; }
-       function getLabel() { return $this->mLabel; }
+       function setLabel($label) { $this->label = $label; }
+       function getLabel() { return $this->label; }
        
        function setMaxLength($value) { $this->max_length = $value; }
        function getMaxLength() { return $this->max_length; }
 
-       function setStyle($value)       { $this->mStyle = $value; }
-       function getStyle() { return $this->mStyle; }
-       
-       function setRenderable($flag)   { $this->mRenderable = $flag;   }
-       function isRenderable() { return $this->mRenderable; }
-       
-       function setEnable($flag)       { $this->mEnabled = $flag;      }
-       function isEnable()     { return $this->mEnabled; }
+       function setStyle($value) { $this->style = $value; }
+       function getStyle() { return $this->style; }
+
+       function setEnabled($flag) { $this->enabled = $flag; }
+       function isEnabled() { return $this->enabled; }
        
-       function setOnChange($str)      { $this->mOnChange = $str; }
-       function setOnClick($str)       { $this->mOnClick = $str; }
-       function setOnSelect($str)      { $this->mOnSelect = $str; }
+       function setOnChange($str) { $this->on_change = $str; }
+       function setOnClick($str) { $this->on_click = $str; }
 
        function setLocalization($i18n) {
-               $this->mI18n = $i18n;
-       }
+        }
        
        function toStringControl()      {
                return "";
        }
-       
+
        function toStringLabel() {
-           return "<label for=\"" . $this->id . "\">" . $this->mLabel . "</label>";
+           return "<label for=\"" . $this->id . "\">" . $this->label . "</label>";
        }
        
        function toArray() {