Added a comment explaining the purpose of safe functions.
[timetracker.git] / WEB-INF / lib / form / Combobox.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 import('form.FormElement');
30         
31 //  name        CDATA          #IMPLIED  -- field name --
32 //  size        NUMBER         #IMPLIED  -- rows visible --
33 //  multiple    (multiple)     #IMPLIED  -- default is single selection --
34 //  disabled    (disabled)     #IMPLIED  -- unavailable in this context --
35 //  tabindex    NUMBER         #IMPLIED  -- position in tabbing order --
36 //  onfocus     %Script;       #IMPLIED  -- the element got the focus --
37 //  onblur      %Script;       #IMPLIED  -- the element lost the focus --
38 //  onchange    %Script;       #IMPLIED  -- the element value was changed --
39
40 class Combobox extends FormElement {
41     var $mMultiple      = false;
42     var $mOptions       = array();
43     var $mOptionsEmpty  = array();
44     var $mCompareOn = "key"; // or "value"
45     var $mDataDeep = 1;
46     var $mDataKeys = array();
47     var $class = 'Combobox';
48
49         function __construct($name,$value="")
50         {
51                 $this->name = $name;
52                 $this->value = $value;
53         }
54
55         function setMultiple($value)    { $this->mMultiple = $value; }
56         function isMultiple() { return $this->mMultiple; }
57         
58         function setData($value)        { $this->mOptions = $value; }
59         function getData() { return $this->mOptions; }
60         
61         function setDataDefault($value) { $this->mOptionsEmpty = $value; }
62         function getDataDefault() { return $this->mOptionsEmpty; }
63         
64         function setDataKeys($keys)     { $this->mDataKeys = $keys; $this->mDataDeep = 2; }
65         function getDataKeys() { return $this->mDataKeys; }
66         
67         
68         function toStringControl() {
69
70             if ($this->id=="") $this->id = $this->name;
71             
72                 $html = "\n\t<select";
73                 $html .= " name=\"$this->name\" id=\"$this->id\"";
74                 
75                 if ($this->size!="")
76                   $html .= " size=\"$this->size\"";
77                  
78                 if ($this->mMultiple)
79                   $html .= " multiple";
80
81                 if ($this->on_change!="")
82                    $html .= " onchange=\"$this->on_change\"";
83                    
84                 if ($this->style!="")
85                    $html .= " style=\"$this->style\"";
86                 
87                 if (!$this->isEnabled())
88                    $html .= " disabled";
89                    
90                 $html .= ">\n";   
91                 if (is_array($this->mOptionsEmpty) && (count($this->mOptionsEmpty) > 0))
92                 foreach ($this->mOptionsEmpty as $key=>$value) {
93                         $html .= "<option value=\"".$key."\"";
94                         if (($this->value == $value) && ($this->value != '')) $html .= " selected";
95                         $html .= ">".$value."</option>\n";
96                 }
97                 if (is_array($this->mOptions) && (count($this->mOptions) > 0))
98                 foreach ($this->mOptions as $key=>$value) {
99
100                         if ($this->mDataDeep>1) {
101                                 $key = $value[$this->mDataKeys[0]];
102                                 $value = $value[$this->mDataKeys[1]];
103                         }
104                         $html .= "<option value=\"".$key."\"";
105                         if (($this->value == $key) && ($this->value != '')) $html .= " selected";
106                         $html .= ">".htmlspecialchars($value)."</option>\n";
107                 }
108                 
109                 $html .= "</select>";
110                 
111                 return $html;
112         }
113 }
114 ?>