Framework  3.9
text_field_renderer.inc
Go to the documentation of this file.
1 <?php
6 /**************************************************************
7 
8  Copyright (c) 2007-2010 Sonjara, Inc
9 
10  Permission is hereby granted, free of charge, to any person
11  obtaining a copy of this software and associated documentation
12  files (the "Software"), to deal in the Software without
13  restriction, including without limitation the rights to use,
14  copy, modify, merge, publish, distribute, sublicense, and/or sell
15  copies of the Software, and to permit persons to whom the
16  Software is furnished to do so, subject to the following
17  conditions:
18 
19  The above copyright notice and this permission notice shall be
20  included in all copies or substantial portions of the Software.
21 
22  Except as contained in this notice, the name(s) of the above
23  copyright holders shall not be used in advertising or otherwise
24  to promote the sale, use or other dealings in this Software
25  without prior written authorization.
26 
27  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
29  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
31  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
32  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
33  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34  OTHER DEALINGS IN THE SOFTWARE.
35 
36 *****************************************************************/
37 
38 require_once realpath(dirname(__FILE__))."/../field_renderers.inc";
39 
51 {
52  var $rows = 4;
53  var $columns = 60;
54  var $colspan = 2;
55  var $limit = 0;
56  var $disable = false;
57  var $encoding = "UTF-8";
58  var $style;
59  var $placeholder = null;
60 
66  {
67  global $config;
68 
69  $this->FieldRenderer($parent);
70 
71  $this->annotateBefore = true;
72  if ($config["encoding"]) $this->encoding = $config["encoding"];
73  }
74 
75  function renderScript($field)
76  {
77  if ($this->limit)
78  {
79 ?>
80 <script type='text/javascript'>
81 /* <![CDATA[ */
82  function <?echo $field ?>_keyup(event)
83  {
84  var form = document.getElementById('<?echo $this->parent->id ?>');
85  var ctrl = form['<?echo $field ?>'];
86  var len = ctrl.value.length;
87  if (len >= <?echo $this->limit?>)
88  {
89  ctrl.value = ctrl.value.substring(0, <?echo $this->limit ?>);
90  len = <?echo $this->limit ?>;
91  }
92 
93  var count = document.getElementById('<?echo $field ?>_length');
94  count.innerHTML = len;
95  }
96 </script>
97 <?
98  }
99  }
100 
101  function renderField($field)
102  {
103  $this->_startField($field);
104 
105  if ($this->limit)
106  {
107  echo "<div>";
108  $onkeypress = " onkeyup='{$field}_keyup(event);'";
109  }
110  $disable = ($this->disable) ? "disabled='disabled'" : "";
111 
112  if ($this->style) $style = "style='{$this->style}'";
113 
114  $placeholder = ($this->placeholder) ? " placeholder='".htmlSafe($this->placeholder)."'" : "";
115 
116  echo "<textarea id='{$this->parent->id}_$field' name='$field' rows='{$this->rows}' cols='{$this->columns}'{$placeholder} $style $disable $onkeypress>";
117  echo cleanHTMLTags($this->parent->data->get($field));
118  //echo htmlspecialchars($this->parent->data->get($field), ENT_QUOTES | ENT_IGNORE, $this->encoding);
119  echo "</textarea>";
120 
121  if ($this->limit)
122  {
123  echo "<br /><div class='character_count' style='clear: left; float: right'><span id='{$field}_length'>";
124  echo strlen(trim($this->parent->data->get($field)));
125  echo "</span> of $this->limit characters</div></div>";
126  }
127 
128  $this->_endField($field);
129  }
130 
131  function renderReadOnly($field)
132  {
133  $this->_startField($field);
134 
135  $text = htmlspecialchars($this->parent->data->get($field), ENT_QUOTES | ENT_IGNORE, 'UTF-8');
136  $text = str_replace("\n", "<br/>", $text);
137  echo $text;
138 
139  $this->_endField($field);
140  }
141 
142  function renderSearchField($field, $mode = "like")
143  {
144  // AJG - Override default colspan when rendering in a search form
145  $this->colspan = 1;
146 
147  if ($mode == "range")
148  {
149  $from = htmlspecialchars($this->parent->params->get($field, "from"), ENT_QUOTES, 'UTF-8');
150  $to = htmlspecialchars($this->parent->params->get($field, "to"), ENT_QUOTES, 'UTF-8');
151 
152  echo "<tr>\n";
153  $this->_printLabel($field);
154  echo "<td>From <input type='text' name='$field:from' value='{$from}' size='25'> to <input type='text' name='$field:to' value='{$to}' size='25'></td>\n";
155  echo "</tr>\n";
156  }
157  else
158  {
159  $value = htmlspecialchars($this->parent->params->get($field, $mode), ENT_QUOTES, 'UTF-8');
160  echo "<tr>\n";
161  $this->_printLabel($field);
162 
163  $placeholder = ($this->placeholder) ? " placeholder='".htmlSafe($this->placeholder)."'" : "";
164  echo "<td><input type='text' name='$field:$mode' value='{$value}'{$placeholder} size='50'></td>\n";
165  echo "</tr>\n";
166  }
167  }
168 }
169 
170  ?>
FieldRenderer is the abstract base class for all FieldRenderers.
_startField($field, $styles="")
Internal method to generate the starting HTML for the field (including the label)
_endField($field)
Internal method to generate the closing HTML for the field.
_printLabel($field, $colspan=1, $styles="", $annotation="")
Internal method to generate the HTML for the field label.
FieldRenderer($parent)
Constructor.
Field renderer for text data fields.
TextFieldRenderer(&$parent)
Constructs a new TextFieldRenderer object.
$columns
The number of columns to display in the text area.
$rows
The number of rows to display in the text area.
$colspan
The number of table columns to display across.
renderField($field)
FieldRenderers must override this method to provide the HTML implementation of the control used to ed...
$style
Inline styles for the text area element.
$placeholder
Placeholder text to display when field is empty.
$disable
Alternative to readonly; field can be reenabled thru javascript.
$encoding
Overrides the default text encoding.
renderScript($field)
FieldRenderers can override this method to provide any Javascript that their control requires for an ...
renderSearchField($field, $mode="like")
FieldRenderers must override this method to provide the HTML implementation of the control displayed ...
$limit
Optional limit on the number of characters allowed to be entered (enforced by Javascript)....
cleanHTMLTags($str)
Definition: functions.inc:456