Further refactoring of the FormElement class.

[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 20fdb07..f3d26a4 100644 (file)
--- a/WEB-INF/lib/form/FormElement.class.php
+++ b/WEB-INF/lib/form/FormElement.class.php
@@ -39,52 +39,61 @@ class FormElement {
   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 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; }
+
+  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->label = $label; }
+  function getLabel() { return $this->label; }
+
+  function setMaxLength($value) { $this->max_length = $value; }
+  function getMaxLength() { return $this->max_length; }
+
+  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->on_change = $str; }
+  function setOnClick($str) { $this->on_click = $str; }
+
+  function localize($i18n) {} // Localization occurs in derived classes and is dependent on control type.
+                              // For example, in calendar control we need to localize day and month names.
+
   // TODO: refactoring ongoing down from here.
-       var $cClassName         = "FormElement";
-       var $mI18n                      = null;
 
-       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 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->label = $label; }
-       function getLabel() { return $this->label; }
+
        
-       function setMaxLength($value) { $this->max_length = $value; }
-       function getMaxLength() { return $this->max_length; }
 
-       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->on_change = $str; }
-       function setOnClick($str) { $this->on_click = $str; }
 
-       function setLocalization($i18n) {
-               $this->mI18n = $i18n;
-       }
        
        function toStringControl()      {
                return "";