// | https://www.anuko.com/time_tracker/credits.htm
// +----------------------------------------------------------------------+
+// FromElement is the base class for controls on forms.
class FormElement {
- var $mId = "";
- var $mName;
- var $mFormName = "";
- var $mValue = "";
- var $mSize = "";
- var $mMaxLength = "";
- var $mTabindex = "";
- var $mAccesskey = "";
- 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;
-
- function __construct() {
- }
-
- function getClass() { return $this->cClassName; }
-
- function setName($name) { $this->mName = $name; }
- function getName() { return $this->mName; }
-
- function setFormName($name) { $this->mFormName = $name; }
- function getFormName() { return $this->mFormName; }
-
- function setValue($value) { $this->mValue = $value;}
- function getValue() { return $this->mValue; }
-
- function setValueSafe($value) { $this->mValue = $value;}
- function getValueSafe() { return $this->mValue; }
-
- function setId($id) { $this->mId = $id; }
- function getId() { return $this->mId; }
-
- function setSize($value) { $this->mSize = $value; }
- function getSize() { return $this->mSize; }
-
- function setLabel($label) { $this->mLabel = $label; }
- function getLabel() { return $this->mLabel; }
-
- function setMaxLength($value) { $this->mMaxLength = $value; }
- function getMaxLength() { return $this->mMaxLength; }
-
- function setTabindex($value) { $this->mTabindex = $value; }
- function getTabindex() { return $this->mTabindex; }
-
- function setAccesskey($value) { $this->mAccesskey = $value; }
- function getAccesskey() { return $this->mAccesskey; }
-
- 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 setOnChange($str) { $this->mOnChange = $str; }
- function setOnClick($str) { $this->mOnClick = $str; }
- function setOnSelect($str) { $this->mOnSelect = $str; }
-
- function setLocalization($i18n) {
- $this->mI18n = $i18n;
- }
-
- function toStringControl() {
- return "";
- }
-
- function toStringLabel() {
- return "<label for=\"" . $this->mId . "\">" . $this->mLabel . "</label>";
- }
-
- function toArray() {
- return array(
- "label"=>$this->toStringLabel(),
- "control"=>$this->toStringControl()
- );
- }
+ 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 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.
+
+ // 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());
+ }
}