Some further refactoring in form classes.

[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 c6182d3..799abf7 100644 (file)
--- a/WEB-INF/lib/form/FormElement.class.php
+++ b/WEB-INF/lib/form/FormElement.class.php
@@ -46,54 +46,53 @@ class FormElement {
 
   function getName() { return $this->name; }
   function getClass() { return $this->class; }
-  
-  // TODO: refactoring ongoing down from here.
-       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) {
-        }
-       
-       function toStringControl()      {
-               return "";
-       }
-
-       function toStringLabel() {
-           return "<label for=\"" . $this->id . "\">" . $this->label . "</label>";
-       }
-       
-       function toArray() {
-           return array(
-                    "label"=>$this->toStringLabel(),
-                    "control"=>$this->toStringControl()
-                  );
-       }
 
+  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.
+
+  // getHtml returns HTML for the element.
+  function getHtml() { return ''; }
+
+  // getLabelHtml returns HTML code for element label.
+  function getLabelHtml() { return '<label for="'.$this->id.'">'.$this->label.'</label>'; }
+
+  function toArray() {
+    return array(
+      'label'=>$this->getLabelHtml(),
+      'control'=>$this->getHtml());
+  }
 }