WEB-INF/lib/form/FormElement.class.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 // FromElement is the base class for controls on forms.
  30 class FormElement {
  31   var $id = '';         // Control id.
  32   var $name;            // Control name.
  33   var $form_name = '';  // Form name the control is in.
  34   var $value = '';      // Value of the control.
  35   var $size = '';       // Control size.
  36   var $max_length = ''; // Max lenght of text in control.
  37   var $on_change = '';  // What happens when value of control changes.
  38   var $on_click = '';   // What happens when the control is clicked.
  39
  40   // TODO: refactoring ongoing down from here.
  41         var $mOnKeyPress        = ""; // This is only used in TextArea, consider moving out of the base class.
  42         var $mOnFocus           = "";
  43         var $mLabel         = "";
  44         var $mStyle         = "";
  45         var $mRenderable    = true;
  46         var $mEnabled           = true;
  47         var $cClassName         = "FormElement";
  48         var $mI18n                      = null;
  49
  50         function __construct() {
  51         }
  52
  53         function getClass()     { return $this->cClassName; }
  54
  55         function setName($name) { $this->name = $name; }
  56         function getName()      { return $this->name; }
  57
  58         function setFormName($name) { $this->form_name = $name; }
  59         function getFormName()  { return $this->form_name; }
  60
  61         function setValue($value) { $this->value = $value;}
  62         function getValue() { return $this->value; }
  63
  64         function setValueSafe($value) { $this->value = $value;}
  65         function getValueSafe() { return $this->value; }
  66
  67         function setId($id) { $this->id = $id;  }
  68         function getId() { return $this->id; }
  69
  70         function setSize($value) { $this->size = $value; }
  71         function getSize() { return $this->size; }
  72
  73         function setLabel($label)       { $this->mLabel = $label; }
  74         function getLabel() { return $this->mLabel; }
  75
  76         function setMaxLength($value) { $this->max_length = $value; }
  77         function getMaxLength() { return $this->max_length; }
  78
  79         function setStyle($value)       { $this->mStyle = $value; }
  80         function getStyle() { return $this->mStyle; }
  81
  82         function setRenderable($flag)   { $this->mRenderable = $flag;   }
  83         function isRenderable() { return $this->mRenderable; }
  84
  85         function setEnable($flag)       { $this->mEnabled = $flag;      }
  86         function isEnable()     { return $this->mEnabled; }
  87
  88         function setOnChange($str) { $this->on_change = $str; }
  89         function setOnClick($str) { $this->on_click = $str; }
  90
  91         function setLocalization($i18n) {
  92                 $this->mI18n = $i18n;
  93         }
  94
  95         function toStringControl()      {
  96                 return "";
  97         }
  98
  99         function toStringLabel() {
 100             return "<label for=\"" . $this->id . "\">" . $this->mLabel . "</label>";
 101         }
 102
 103         function toArray() {
 104             return array(
 105                      "label"=>$this->toStringLabel(),
 106                      "control"=>$this->toStringControl()
 107                    );
 108         }
 109
 110 }