1 <?xml version=
"1.0" encoding=
"iso-8859-1"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml">
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class EntryForm
</title>
7 <link rel=
"stylesheet" href=
"../../media/stylesheet.css" />
8 <script src=
"../../media/lib/classTree.js"></script>
9 <script language=
"javascript" type=
"text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src =
"../../media/images/plus.png";
13 imgMinus.src =
"../../media/images/minus.png";
15 function showNode(Node){
16 switch(navigator.family){
18 // Nav
4.x code fork...
19 var oTable = document.layers[
"span" + Node];
20 var oImg = document.layers[
"img" + Node];
23 // IE
4/
5 code fork...
24 var oTable = document.all[
"span" + Node];
25 var oImg = document.all[
"img" + Node];
28 // Standards Compliant code fork...
29 var oTable = document.getElementById(
"span" + Node);
30 var oImg = document.getElementById(
"img" + Node);
33 oImg.src = imgMinus.src;
34 oTable.style.display =
"block";
37 function hideNode(Node){
38 switch(navigator.family){
40 // Nav
4.x code fork...
41 var oTable = document.layers[
"span" + Node];
42 var oImg = document.layers[
"img" + Node];
45 // IE
4/
5 code fork...
46 var oTable = document.all[
"span" + Node];
47 var oImg = document.all[
"img" + Node];
50 // Standards Compliant code fork...
51 var oTable = document.getElementById(
"span" + Node);
52 var oImg = document.getElementById(
"img" + Node);
55 oImg.src = imgPlus.src;
56 oTable.style.display =
"none";
59 function nodeIsVisible(Node){
60 switch(navigator.family){
62 // Nav
4.x code fork...
63 var oTable = document.layers[
"span" + Node];
66 // IE
4/
5 code fork...
67 var oTable = document.all[
"span" + Node];
70 // Standards Compliant code fork...
71 var oTable = document.getElementById(
"span" + Node);
74 return (oTable && oTable.style.display ==
"block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
87 <div class=
"page-body">
88 <h2 class=
"class-name"><img src=
"../../media/images/Class_logo.png"
91 style=
"vertical-align: middle"> EntryForm
</h2>
93 <a name=
"sec-description"></a>
94 <div class=
"info-box">
95 <div class=
"info-box-title">Description
</div>
97 <span class=
"disabled">Description
</span> |
98 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
101 <div class=
"info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class=
"short-description">A class to handle displaying a form on the page (for editing) or a structured layout of non-editable content (for viewing), with a simple switch to flip from view mode to edit mode.
</p>
105 Located in
<a class=
"field" href=
"_DataEntry.php.html">/DataEntry.php
</a> (line
<span class=
"field">296</span>)
117 <a name=
"sec-method-summary"></a>
118 <div class=
"info-box">
119 <div class=
"info-box-title">Method Summary
</span></div>
120 <div class=
"nav-bar">
121 <a href=
"#sec-description">Description
</a> |
122 <span class=
"disabled">Methods
</span> (
<a href=
"#sec-methods">details
</a>)
124 <div class=
"info-box-body">
125 <div class=
"method-summary">
127 <div class=
"method-definition">
128 <img src=
"../../media/images/StaticMethod.png" alt=
" "/>
129 static
<span class=
"method-result">string
</span>
130 <a href=
"#_ParseAttributes" title=
"details" class=
"method-name">_ParseAttributes
</a>
131 ([
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>])
134 <div class=
"method-definition">
135 <img src=
"../../media/images/Constructor.png" alt=
" "/>
136 <span class=
"method-result">EntryForm
</span>
137 <a href=
"#EntryForm" title=
"details" class=
"method-name">EntryForm
</a>
138 (
<span class=
"var-type">string
</span> <span class=
"var-name">$action
</span>,
<span class=
"var-type"></span> <span class=
"var-name">&$record
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$editing
</span> =
<span class=
"var-default">false
</span>],
<span class=
"var-type">objectref
</span> <span class=
"var-name">$record
</span>,
<span class=
"var-type">boolean
</span> <span class=
"var-name">$editmode
</span>)
141 <div class=
"method-definition">
142 <img src=
"../../media/images/Method.png" alt=
" "/>
143 <span class=
"method-result">string
</span>
144 <a href=
"#BreakLine" title=
"details" class=
"method-name">BreakLine
</a>
145 ([
<span class=
"var-type"></span> <span class=
"var-name">$text
</span> =
<span class=
"var-default">''
</span>])
148 <div class=
"method-definition">
149 <img src=
"../../media/images/Method.png" alt=
" "/>
150 <span class=
"method-result">string
</span>
151 <a href=
"#DataEntryField" title=
"details" class=
"method-name">DataEntryField
</a>
152 (
<span class=
"var-type"></span> <span class=
"var-name">$format
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$base_fname
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">''
</span>])
155 <div class=
"method-definition">
156 <img src=
"../../media/images/Method.png" alt=
" "/>
157 <span class=
"method-result">string
</span>
158 <a href=
"#DataEntryLine" title=
"details" class=
"method-name">DataEntryLine
</a>
159 (
<span class=
"var-type"></span> <span class=
"var-name">$prompt
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$field_format
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$fname
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">''
</span>])
162 <div class=
"method-definition">
163 <img src=
"../../media/images/Method.png" alt=
" "/>
164 <span class=
"method-result">string
</span>
165 <a href=
"#EndForm" title=
"details" class=
"method-name">EndForm
</a>
169 <div class=
"method-definition">
170 <img src=
"../../media/images/Method.png" alt=
" "/>
171 <span class=
"method-result">void
</span>
172 <a href=
"#HelpInCell" title=
"details" class=
"method-name">HelpInCell
</a>
176 <div class=
"method-definition">
177 <img src=
"../../media/images/Method.png" alt=
" "/>
178 <span class=
"method-result">void
</span>
179 <a href=
"#HelpInLine" title=
"details" class=
"method-name">HelpInLine
</a>
183 <div class=
"method-definition">
184 <img src=
"../../media/images/Method.png" alt=
" "/>
185 <span class=
"method-result">string
</span>
186 <a href=
"#HiddenField" title=
"details" class=
"method-name">HiddenField
</a>
187 (
<span class=
"var-type">string
</span> <span class=
"var-name">$fname
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$fvalue
</span>)
190 <div class=
"method-definition">
191 <img src=
"../../media/images/Method.png" alt=
" "/>
192 <span class=
"method-result">string
</span>
193 <a href=
"#MultiEntryLine" title=
"details" class=
"method-name">MultiEntryLine
</a>
194 (
<span class=
"var-type"></span> <span class=
"var-name">$prompt_options
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$prompt_name
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$default_prompt
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$format
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$fname
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>],
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span>)
197 <div class=
"method-definition">
198 <img src=
"../../media/images/Method.png" alt=
" "/>
199 <span class=
"method-result">void
</span>
200 <a href=
"#NoHelp" title=
"details" class=
"method-name">NoHelp
</a>
204 <div class=
"method-definition">
205 <img src=
"../../media/images/Method.png" alt=
" "/>
206 <span class=
"method-result">void
</span>
207 <a href=
"#PopulateForm" title=
"details" class=
"method-name">PopulateForm
</a>
208 (
<span class=
"var-type"></span> <span class=
"var-name">&$record
</span>, [
<span class=
"var-type">string
</span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">""</span>],
<span class=
"var-type">objectref
</span> <span class=
"var-name">$record
</span>)
211 <div class=
"method-definition">
212 <img src=
"../../media/images/Method.png" alt=
" "/>
213 <span class=
"method-result">void
</span>
214 <a href=
"#RevertLineFormat" title=
"details" class=
"method-name">RevertLineFormat
</a>
218 <div class=
"method-definition">
219 <img src=
"../../media/images/Method.png" alt=
" "/>
220 <span class=
"method-result">void
</span>
221 <a href=
"#SimpleForm" title=
"details" class=
"method-name">SimpleForm
</a>
222 ([
<span class=
"var-type"></span> <span class=
"var-name">$new_format
</span> =
<span class=
"var-default">'
<span class=
"prompt
">%s:
</span
>&nbsp;
<span class=
"entry
">%s
</span
>'
</span>])
225 <div class=
"method-definition">
226 <img src=
"../../media/images/Method.png" alt=
" "/>
227 <span class=
"method-result">string
</span>
228 <a href=
"#StartForm" title=
"details" class=
"method-name">StartForm
</a>
229 ([
<span class=
"var-type">array
</span> <span class=
"var-name">$extra_attributes
</span> =
<span class=
"var-default">''
</span>])
232 <div class=
"method-definition">
233 <img src=
"../../media/images/Method.png" alt=
" "/>
234 <span class=
"method-result">string
</span>
235 <a href=
"#SubmitButton" title=
"details" class=
"method-name">SubmitButton
</a>
236 (
<span class=
"var-type"></span> <span class=
"var-name">$fname
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$fvalue
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>])
239 <div class=
"method-definition">
240 <img src=
"../../media/images/Method.png" alt=
" "/>
241 <span class=
"method-result">void
</span>
242 <a href=
"#TempLineFormat" title=
"details" class=
"method-name">TempLineFormat
</a>
243 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$new_format
</span> =
<span class=
"var-default">'
<span class=
"prompt
">%s:
</span
>&nbsp;
<span class=
"entry
">%s
</span
>'
</span>])
250 <a name=
"sec-methods"></a>
251 <div class=
"info-box">
252 <div class=
"info-box-title">Methods
</div>
253 <div class=
"nav-bar">
254 <a href=
"#sec-description">Description
</a> |
255 <a href=
"#sec-method-summary">Methods
</a> (
<span class=
"disabled">details
</span>)
258 <div class=
"info-box-body">
259 <A NAME='method_detail'
></A>
260 <a name=
"method_ParseAttributes" id=
"_ParseAttributes"><!-- --></a>
263 <div class=
"method-header">
264 <img src=
"../../media/images/StaticMethod.png" />
265 <span class=
"method-title">static _ParseAttributes
</span> (line
<span class=
"line-number">492</span>)
268 <!-- ========== Info from phpDoc block ========= -->
269 <p class=
"short-description">Internal function for parsing the type extra on a field.
</p>
270 <p class=
"description"><p>If the '_help' attribute is not set it will be assigned the value of the 'title' attribute, if there is one.
</p><p>If the 'class' attribute is not set it will be assigned to 'flookup', 'fselect', etc, according to the field type.
</p></p>
272 <li><span class=
"field">return:
</span> The parsed type extra.
</li>
275 <div class=
"method-signature">
276 static
<span class=
"method-result">string
</span>
277 <span class=
"method-name">
280 ([
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>])
283 <ul class=
"parameters">
285 <span class=
"var-type"></span>
286 <span class=
"var-name">$ftype
</span> </li>
288 <span class=
"var-type"></span>
289 <span class=
"var-name">$attributes
</span> </li>
294 <a name=
"methodEntryForm" id=
"EntryForm"><!-- --></a>
295 <div class=
"evenrow">
297 <div class=
"method-header">
298 <img src=
"../../media/images/Constructor.png" />
299 <span class=
"method-title">Constructor EntryForm
</span> (line
<span class=
"line-number">356</span>)
302 <!-- ========== Info from phpDoc block ========= -->
303 <p class=
"short-description">Initialise a new data-entry form.
</p>
305 <div class=
"method-signature">
306 <span class=
"method-result">EntryForm
</span>
307 <span class=
"method-name">
310 (
<span class=
"var-type">string
</span> <span class=
"var-name">$action
</span>,
<span class=
"var-type"></span> <span class=
"var-name">&$record
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$editing
</span> =
<span class=
"var-default">false
</span>],
<span class=
"var-type">objectref
</span> <span class=
"var-name">$record
</span>,
<span class=
"var-type">boolean
</span> <span class=
"var-name">$editmode
</span>)
313 <ul class=
"parameters">
315 <span class=
"var-type">string
</span>
316 <span class=
"var-name">$action
</span><span class=
"var-description">: The action when the form is submitted.
</span> </li>
318 <span class=
"var-type">objectref
</span>
319 <span class=
"var-name">$record
</span><span class=
"var-description">: A reference to the database object we are displaying / editing.
</span> </li>
321 <span class=
"var-type">boolean
</span>
322 <span class=
"var-name">$editmode
</span><span class=
"var-description">: Whether we are editing.
</span> </li>
324 <span class=
"var-type"></span>
325 <span class=
"var-name">&$record
</span> </li>
327 <span class=
"var-type"></span>
328 <span class=
"var-name">$editing
</span> </li>
333 <a name=
"methodBreakLine" id=
"BreakLine"><!-- --></a>
336 <div class=
"method-header">
337 <img src=
"../../media/images/Method.png" />
338 <span class=
"method-title">BreakLine
</span> (line
<span class=
"line-number">465</span>)
341 <!-- ========== Info from phpDoc block ========= -->
342 <p class=
"short-description">A utility function for a heading line within a data entry table
</p>
344 <li><span class=
"field">return:
</span> The HTML fragment to end the form.
</li>
347 <div class=
"method-signature">
348 <span class=
"method-result">string
</span>
349 <span class=
"method-name">
352 ([
<span class=
"var-type"></span> <span class=
"var-name">$text
</span> =
<span class=
"var-default">''
</span>])
355 <ul class=
"parameters">
357 <span class=
"var-type"></span>
358 <span class=
"var-name">$text
</span> </li>
363 <a name=
"methodDataEntryField" id=
"DataEntryField"><!-- --></a>
364 <div class=
"evenrow">
366 <div class=
"method-header">
367 <img src=
"../../media/images/Method.png" />
368 <span class=
"method-title">DataEntryField
</span> (line
<span class=
"line-number">523</span>)
371 <!-- ========== Info from phpDoc block ========= -->
372 <p class=
"short-description">A utility function for a data entry line within a table
</p>
374 <li><span class=
"field">return:
</span> The HTML fragment to display the data entry field
</li>
377 <div class=
"method-signature">
378 <span class=
"method-result">string
</span>
379 <span class=
"method-name">
382 (
<span class=
"var-type"></span> <span class=
"var-name">$format
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$base_fname
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">''
</span>])
385 <ul class=
"parameters">
387 <span class=
"var-type"></span>
388 <span class=
"var-name">$format
</span> </li>
390 <span class=
"var-type"></span>
391 <span class=
"var-name">$ftype
</span> </li>
393 <span class=
"var-type"></span>
394 <span class=
"var-name">$base_fname
</span> </li>
396 <span class=
"var-type"></span>
397 <span class=
"var-name">$attributes
</span> </li>
399 <span class=
"var-type"></span>
400 <span class=
"var-name">$prefix
</span> </li>
405 <a name=
"methodDataEntryLine" id=
"DataEntryLine"><!-- --></a>
408 <div class=
"method-header">
409 <img src=
"../../media/images/Method.png" />
410 <span class=
"method-title">DataEntryLine
</span> (line
<span class=
"line-number">599</span>)
413 <!-- ========== Info from phpDoc block ========= -->
414 <p class=
"short-description">A utility function for a data entry line within a table
</p>
416 <li><span class=
"field">return:
</span> The HTML fragment to display the prompt and field.
</li>
419 <div class=
"method-signature">
420 <span class=
"method-result">string
</span>
421 <span class=
"method-name">
424 (
<span class=
"var-type"></span> <span class=
"var-name">$prompt
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$field_format
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$fname
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">''
</span>])
427 <ul class=
"parameters">
429 <span class=
"var-type"></span>
430 <span class=
"var-name">$prompt
</span> </li>
432 <span class=
"var-type"></span>
433 <span class=
"var-name">$field_format
</span> </li>
435 <span class=
"var-type"></span>
436 <span class=
"var-name">$ftype
</span> </li>
438 <span class=
"var-type"></span>
439 <span class=
"var-name">$fname
</span> </li>
441 <span class=
"var-type"></span>
442 <span class=
"var-name">$attributes
</span> </li>
444 <span class=
"var-type"></span>
445 <span class=
"var-name">$prefix
</span> </li>
450 <a name=
"methodEndForm" id=
"EndForm"><!-- --></a>
451 <div class=
"evenrow">
453 <div class=
"method-header">
454 <img src=
"../../media/images/Method.png" />
455 <span class=
"method-title">EndForm
</span> (line
<span class=
"line-number">457</span>)
458 <!-- ========== Info from phpDoc block ========= -->
459 <p class=
"short-description">Return the HTML fragment to end the form.
</p>
461 <li><span class=
"field">return:
</span> The HTML fragment to end the form.
</li>
464 <div class=
"method-signature">
465 <span class=
"method-result">string
</span>
466 <span class=
"method-name">
475 <a name=
"methodHelpInCell" id=
"HelpInCell"><!-- --></a>
478 <div class=
"method-header">
479 <img src=
"../../media/images/Method.png" />
480 <span class=
"method-title">HelpInCell
</span> (line
<span class=
"line-number">396</span>)
483 <!-- ========== Info from phpDoc block ========= -->
484 <p class=
"short-description">Set the line format to have help displayed in it's own separate cell
</p>
486 <div class=
"method-signature">
487 <span class=
"method-result">void
</span>
488 <span class=
"method-name">
497 <a name=
"methodHelpInLine" id=
"HelpInLine"><!-- --></a>
498 <div class=
"evenrow">
500 <div class=
"method-header">
501 <img src=
"../../media/images/Method.png" />
502 <span class=
"method-title">HelpInLine
</span> (line
<span class=
"line-number">388</span>)
505 <!-- ========== Info from phpDoc block ========= -->
506 <p class=
"short-description">Set the line format to have help displayed in the same cell as the entry field.
</p>
508 <div class=
"method-signature">
509 <span class=
"method-result">void
</span>
510 <span class=
"method-name">
519 <a name=
"methodHiddenField" id=
"HiddenField"><!-- --></a>
522 <div class=
"method-header">
523 <img src=
"../../media/images/Method.png" />
524 <span class=
"method-title">HiddenField
</span> (line
<span class=
"line-number">477</span>)
527 <!-- ========== Info from phpDoc block ========= -->
528 <p class=
"short-description">A utility function for a hidden field within a data entry table
</p>
530 <li><span class=
"field">return:
</span> The HTML fragment for the hidden field.
</li>
533 <div class=
"method-signature">
534 <span class=
"method-result">string
</span>
535 <span class=
"method-name">
538 (
<span class=
"var-type">string
</span> <span class=
"var-name">$fname
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$fvalue
</span>)
541 <ul class=
"parameters">
543 <span class=
"var-type">string
</span>
544 <span class=
"var-name">$fname
</span><span class=
"var-description">: The name of the field.
</span> </li>
546 <span class=
"var-type">string
</span>
547 <span class=
"var-name">$fvalue
</span><span class=
"var-description">: The value of the field.
</span> </li>
552 <a name=
"methodMultiEntryLine" id=
"MultiEntryLine"><!-- --></a>
553 <div class=
"evenrow">
555 <div class=
"method-header">
556 <img src=
"../../media/images/Method.png" />
557 <span class=
"method-title">MultiEntryLine
</span> (line
<span class=
"line-number">612</span>)
560 <!-- ========== Info from phpDoc block ========= -->
561 <p class=
"short-description">A utility function for a data entry line, where the prompt is a drop-down.
</p>
563 <li><span class=
"field">return:
</span> The HTML fragment for the drop-down prompt and associated entry field.
</li>
566 <div class=
"method-signature">
567 <span class=
"method-result">string
</span>
568 <span class=
"method-name">
571 (
<span class=
"var-type"></span> <span class=
"var-name">$prompt_options
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$prompt_name
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$default_prompt
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$format
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$ftype
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$fname
</span> =
<span class=
"var-default">''
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>],
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span>)
574 <ul class=
"parameters">
576 <span class=
"var-type"></span>
577 <span class=
"var-name">$prompt_options
</span> </li>
579 <span class=
"var-type"></span>
580 <span class=
"var-name">$prompt_name
</span> </li>
582 <span class=
"var-type"></span>
583 <span class=
"var-name">$default_prompt
</span> </li>
585 <span class=
"var-type"></span>
586 <span class=
"var-name">$format
</span> </li>
588 <span class=
"var-type"></span>
589 <span class=
"var-name">$ftype
</span> </li>
591 <span class=
"var-type"></span>
592 <span class=
"var-name">$fname
</span> </li>
594 <span class=
"var-type"></span>
595 <span class=
"var-name">$attributes
</span> </li>
597 <span class=
"var-type"></span>
598 <span class=
"var-name">$prefix
</span> </li>
603 <a name=
"methodNoHelp" id=
"NoHelp"><!-- --></a>
606 <div class=
"method-header">
607 <img src=
"../../media/images/Method.png" />
608 <span class=
"method-title">NoHelp
</span> (line
<span class=
"line-number">380</span>)
611 <!-- ========== Info from phpDoc block ========= -->
612 <p class=
"short-description">Set the line format to have no help display
</p>
614 <div class=
"method-signature">
615 <span class=
"method-result">void
</span>
616 <span class=
"method-name">
625 <a name=
"methodPopulateForm" id=
"PopulateForm"><!-- --></a>
626 <div class=
"evenrow">
628 <div class=
"method-header">
629 <img src=
"../../media/images/Method.png" />
630 <span class=
"method-title">PopulateForm
</span> (line
<span class=
"line-number">370</span>)
633 <!-- ========== Info from phpDoc block ========= -->
634 <p class=
"short-description">Initialise some more of the forms fields, possibly with a prefix
</p>
636 <div class=
"method-signature">
637 <span class=
"method-result">void
</span>
638 <span class=
"method-name">
641 (
<span class=
"var-type"></span> <span class=
"var-name">&$record
</span>, [
<span class=
"var-type">string
</span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">""</span>],
<span class=
"var-type">objectref
</span> <span class=
"var-name">$record
</span>)
644 <ul class=
"parameters">
646 <span class=
"var-type">objectref
</span>
647 <span class=
"var-name">$record
</span><span class=
"var-description">: A reference to the database object we are displaying / editing.
</span> </li>
649 <span class=
"var-type">string
</span>
650 <span class=
"var-name">$prefix
</span><span class=
"var-description">: A prefix to prepend to the field name.
</span> </li>
652 <span class=
"var-type"></span>
653 <span class=
"var-name">&$record
</span> </li>
658 <a name=
"methodRevertLineFormat" id=
"RevertLineFormat"><!-- --></a>
661 <div class=
"method-header">
662 <img src=
"../../media/images/Method.png" />
663 <span class=
"method-title">RevertLineFormat
</span> (line
<span class=
"line-number">421</span>)
666 <!-- ========== Info from phpDoc block ========= -->
667 <p class=
"short-description">Revert the line format to what was in place before the last TempLineFormat call.
</p>
669 <div class=
"method-signature">
670 <span class=
"method-result">void
</span>
671 <span class=
"method-name">
680 <a name=
"methodSimpleForm" id=
"SimpleForm"><!-- --></a>
681 <div class=
"evenrow">
683 <div class=
"method-header">
684 <img src=
"../../media/images/Method.png" />
685 <span class=
"method-title">SimpleForm
</span> (line
<span class=
"line-number">404</span>)
688 <!-- ========== Info from phpDoc block ========= -->
689 <p class=
"short-description">Set the line format to an extremely simple CSS based prompt / field layout.
</p>
691 <div class=
"method-signature">
692 <span class=
"method-result">void
</span>
693 <span class=
"method-name">
696 ([
<span class=
"var-type"></span> <span class=
"var-name">$new_format
</span> =
<span class=
"var-default">'
<span class=
"prompt
">%s:
</span
>&nbsp;
<span class=
"entry
">%s
</span
>'
</span>])
699 <ul class=
"parameters">
701 <span class=
"var-type"></span>
702 <span class=
"var-name">$new_format
</span> </li>
707 <a name=
"methodStartForm" id=
"StartForm"><!-- --></a>
710 <div class=
"method-header">
711 <img src=
"../../media/images/Method.png" />
712 <span class=
"method-title">StartForm
</span> (line
<span class=
"line-number">432</span>)
715 <!-- ========== Info from phpDoc block ========= -->
716 <p class=
"short-description">Start the actual HTML form. Return the fragment to do this.
</p>
718 <li><span class=
"field">return:
</span> The HTML fragment for the start of the form.
</li>
721 <div class=
"method-signature">
722 <span class=
"method-result">string
</span>
723 <span class=
"method-name">
726 ([
<span class=
"var-type">array
</span> <span class=
"var-name">$extra_attributes
</span> =
<span class=
"var-default">''
</span>])
729 <ul class=
"parameters">
731 <span class=
"var-type">array
</span>
732 <span class=
"var-name">$extra_attributes
</span><span class=
"var-description">: Extra key/value pairs for the FORM tag.
</span> </li>
737 <a name=
"methodSubmitButton" id=
"SubmitButton"><!-- --></a>
738 <div class=
"evenrow">
740 <div class=
"method-header">
741 <img src=
"../../media/images/Method.png" />
742 <span class=
"method-title">SubmitButton
</span> (line
<span class=
"line-number">589</span>)
745 <!-- ========== Info from phpDoc block ========= -->
746 <p class=
"short-description">A utility function for a submit button within a data entry table
</p>
748 <li><span class=
"field">return:
</span> The HTML fragment to display a submit button for the form.
</li>
751 <div class=
"method-signature">
752 <span class=
"method-result">string
</span>
753 <span class=
"method-name">
756 (
<span class=
"var-type"></span> <span class=
"var-name">$fname
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$fvalue
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$attributes
</span> =
<span class=
"var-default">''
</span>])
759 <ul class=
"parameters">
761 <span class=
"var-type"></span>
762 <span class=
"var-name">$fname
</span> </li>
764 <span class=
"var-type"></span>
765 <span class=
"var-name">$fvalue
</span> </li>
767 <span class=
"var-type"></span>
768 <span class=
"var-name">$attributes
</span> </li>
773 <a name=
"methodTempLineFormat" id=
"TempLineFormat"><!-- --></a>
776 <div class=
"method-header">
777 <img src=
"../../media/images/Method.png" />
778 <span class=
"method-title">TempLineFormat
</span> (line
<span class=
"line-number">413</span>)
781 <!-- ========== Info from phpDoc block ========= -->
782 <p class=
"short-description">Set the line format to a temporary one that we can revert from.
</p>
784 <div class=
"method-signature">
785 <span class=
"method-result">void
</span>
786 <span class=
"method-name">
789 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$new_format
</span> =
<span class=
"var-default">'
<span class=
"prompt
">%s:
</span
>&nbsp;
<span class=
"entry
">%s
</span
>'
</span>])
792 <ul class=
"parameters">
794 <span class=
"var-type">string
</span>
795 <span class=
"var-name">$new_format
</span><span class=
"var-description">: The (optional) new format we will temporarily use.
</span> </li>
805 <p class=
"notes" id=
"credit">
806 Documentation generated on Thu,
15 Apr
2010 20:
23:
04 +
1200 by
<a href=
"http://www.phpdoc.org" target=
"_blank">phpDocumentor
1.3.2</a>