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 length 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   var $label = '';      // Optional label for control.
  40   var $style = '';      // Control style.
  41   var $enabled = true;  // Whether the control is enabled.
  42   var $class = 'FormElement'; // Class name for the element.
  43
  44   function __construct() {
  45   }
  46
  47   function getName() { return $this->name; }
  48   function getClass() { return $this->class; }
  49
  50   function setFormName($name) { $this->form_name = $name; }
  51   function getFormName() { return $this->form_name; }
  52
  53   function setValue($value) { $this->value = $value; }
  54   function getValue() { return $this->value; }
  55
  56   // Safe function variations are used to store/read values in/from user session for further reuse.
  57   // They may convert data in derived classes to some standard form. For example, floats are stored
  58   // with a dot delimiter (not comma), and dates are stored in DB_DATEFORMAT.
  59   // This allows to reuse data in session even when user changes the deliminter or date format.
  60   function setValueSafe($value) { $this->value = $value;}
  61   function getValueSafe() { return $this->value; }
  62
  63   function setId($id) { $this->id = $id; }
  64   function getId() { return $this->id; }
  65
  66   function setSize($value) { $this->size = $value; }
  67   function getSize() { return $this->size; }
  68
  69   function setLabel($label) { $this->label = $label; }
  70   function getLabel() { return $this->label; }
  71
  72   function setMaxLength($value) { $this->max_length = $value; }
  73   function getMaxLength() { return $this->max_length; }
  74
  75   function setStyle($value) { $this->style = $value; }
  76   function getStyle() { return $this->style; }
  77
  78   function setEnabled($flag) { $this->enabled = $flag; }
  79   function isEnabled() { return $this->enabled; }
  80
  81   function setOnChange($str) { $this->on_change = $str; }
  82   function setOnClick($str) { $this->on_click = $str; }
  83
  84   function localize($i18n) {} // Localization occurs in derived classes and is dependent on control type.
  85                               // For example, in calendar control we need to localize day and month names.
  86
  87   // getHtml returns HTML for the element.
  88   function getHtml() { return ''; }
  89
  90   // getLabelHtml returns HTML code for element label.
  91   function getLabelHtml() { return '<label for="'.$this->id.'">'.$this->label.'</label>'; }
  92
  93   function toArray() {
  94     return array(
  95       'label'=>$this->getLabelHtml(),
  96       'control'=>$this->getHtml());
  97   }
  98 }