?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / classEditor / Editor.html
blobbbf6dccdb92d6020a4c7ea8639870b6dd49857ee
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">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class Editor</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";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> Editor</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
99 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
100
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">The class for the Editor form in full</p>
105 <p class="notes">
106 Located in <a class="field" href="_classEditor.php.html">/classEditor.php</a> (line <span class="field">102</span>)
107 </p>
108
109
110 <pre></pre>
111
112 </div>
113 </div>
114
115
116
117 <a name="sec-var-summary"></a>
118 <div class="info-box">
119 <div class="info-box-title">Variable Summary</span></div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
123 |
124 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
125
126 </div>
127 <div class="info-box-body">
128 <div class="var-summary">
129 <div class="var-title">
130 <img src="../../media/images/Variable.png" alt=" " />
131 <span class="var-type">mixed</span>
132 <a href="#$Action" title="details" class="var-name">$Action</a>
133 </div>
134 <div class="var-title">
135 <img src="../../media/images/Variable.png" alt=" " />
136 <span class="var-type">mixed</span>
137 <a href="#$BaseTable" title="details" class="var-name">$BaseTable</a>
138 </div>
139 <div class="var-title">
140 <img src="../../media/images/Variable.png" alt=" " />
141 <span class="var-type">mixed</span>
142 <a href="#$Fields" title="details" class="var-name">$Fields</a>
143 </div>
144 <div class="var-title">
145 <img src="../../media/images/Variable.png" alt=" " />
146 <span class="var-type">mixed</span>
147 <a href="#$Id" title="details" class="var-name">$Id</a>
148 </div>
149 <div class="var-title">
150 <img src="../../media/images/Variable.png" alt=" " />
151 <span class="var-type">mixed</span>
152 <a href="#$Joins" title="details" class="var-name">$Joins</a>
153 </div>
154 <div class="var-title">
155 <img src="../../media/images/Variable.png" alt=" " />
156 <span class="var-type">mixed</span>
157 <a href="#$Limit" title="details" class="var-name">$Limit</a>
158 </div>
159 <div class="var-title">
160 <img src="../../media/images/Variable.png" alt=" " />
161 <span class="var-type">mixed</span>
162 <a href="#$NewWhere" title="details" class="var-name">$NewWhere</a>
163 </div>
164 <div class="var-title">
165 <img src="../../media/images/Variable.png" alt=" " />
166 <span class="var-type">mixed</span>
167 <a href="#$Order" title="details" class="var-name">$Order</a>
168 </div>
169 <div class="var-title">
170 <img src="../../media/images/Variable.png" alt=" " />
171 <span class="var-type">mixed</span>
172 <a href="#$OrderedFields" title="details" class="var-name">$OrderedFields</a>
173 </div>
174 <div class="var-title">
175 <img src="../../media/images/Variable.png" alt=" " />
176 <span class="var-type">mixed</span>
177 <a href="#$Query" title="details" class="var-name">$Query</a>
178 </div>
179 <div class="var-title">
180 <img src="../../media/images/Variable.png" alt=" " />
181 <span class="var-type">mixed</span>
182 <a href="#$Record" title="details" class="var-name">$Record</a>
183 </div>
184 <div class="var-title">
185 <img src="../../media/images/Variable.png" alt=" " />
186 <span class="var-type">mixed</span>
187 <a href="#$RecordAvailable" title="details" class="var-name">$RecordAvailable</a>
188 </div>
189 <div class="var-title">
190 <img src="../../media/images/Variable.png" alt=" " />
191 <span class="var-type">mixed</span>
192 <a href="#$SubmitName" title="details" class="var-name">$SubmitName</a>
193 </div>
194 <div class="var-title">
195 <img src="../../media/images/Variable.png" alt=" " />
196 <span class="var-type">mixed</span>
197 <a href="#$Template" title="details" class="var-name">$Template</a>
198 </div>
199 <div class="var-title">
200 <img src="../../media/images/Variable.png" alt=" " />
201 <span class="var-type">mixed</span>
202 <a href="#$Title" title="details" class="var-name">$Title</a>
203 </div>
204 <div class="var-title">
205 <img src="../../media/images/Variable.png" alt=" " />
206 <span class="var-type">mixed</span>
207 <a href="#$Where" title="details" class="var-name">$Where</a>
208 </div>
209 </div>
210 </div>
211 </div>
212
213 <a name="sec-method-summary"></a>
214 <div class="info-box">
215 <div class="info-box-title">Method Summary</span></div>
216 <div class="nav-bar">
217 <a href="#sec-description">Description</a> |
218 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
219
220 |
221 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
222 </div>
223 <div class="info-box-body">
224 <div class="method-summary">
225
226 <div class="method-definition">
227 <img src="../../media/images/Constructor.png" alt=" "/>
228 <span class="method-result">Editor</span>
229 <a href="#__construct" title="details" class="method-name">__construct</a>
230 ([<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">null</span>])
231 </div>
232
233 <div class="method-definition">
234 <img src="../../media/images/Method.png" alt=" "/>
235 <span class="method-result">void</span>
236 <a href="#AddAttribute" title="details" class="method-name">AddAttribute</a>
237 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$k</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$v</span>)
238 </div>
239
240 <div class="method-definition">
241 <img src="../../media/images/Method.png" alt=" "/>
242 <span class="method-result">void</span>
243 <a href="#AddField" title="details" class="method-name">&amp;AddField</a>
244 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span> = <span class="var-default">&quot;&quot;</span>])
245 </div>
246
247 <div class="method-definition">
248 <img src="../../media/images/Method.png" alt=" "/>
249 <span class="method-result">void</span>
250 <a href="#AndWhere" title="details" class="method-name">AndWhere</a>
251 (<span class="var-type"></span>&nbsp;<span class="var-name">$more_where</span>)
252 </div>
253
254 <div class="method-definition">
255 <img src="../../media/images/Method.png" alt=" "/>
256 <span class="method-result">void</span>
257 <a href="#Assign" title="details" class="method-name">Assign</a>
258 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value_field_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$new_value</span>)
259 </div>
260
261 <div class="method-definition">
262 <img src="../../media/images/Method.png" alt=" "/>
263 <span class="method-result">void</span>
264 <a href="#Available" title="details" class="method-name">Available</a>
265 ()
266 </div>
267
268 <div class="method-definition">
269 <img src="../../media/images/Method.png" alt=" "/>
270 <span class="method-result">void</span>
271 <a href="#GetRecord" title="details" class="method-name">GetRecord</a>
272 ([<span class="var-type"></span>&nbsp;<span class="var-name">$where</span> = <span class="var-default">&quot;&quot;</span>])
273 </div>
274
275 <div class="method-definition">
276 <img src="../../media/images/Method.png" alt=" "/>
277 <span class="method-result">void</span>
278 <a href="#Id" title="details" class="method-name">Id</a>
279 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
280 </div>
281
282 <div class="method-definition">
283 <img src="../../media/images/Method.png" alt=" "/>
284 <span class="method-result">void</span>
285 <a href="#Initialise" title="details" class="method-name">Initialise</a>
286 (<span class="var-type">array</span>&nbsp;<span class="var-name">$values</span>)
287 </div>
288
289 <div class="method-definition">
290 <img src="../../media/images/Method.png" alt=" "/>
291 <span class="method-result">void</span>
292 <a href="#IsCreate" title="details" class="method-name">IsCreate</a>
293 ()
294 </div>
295
296 <div class="method-definition">
297 <img src="../../media/images/Method.png" alt=" "/>
298 <span class="method-result">void</span>
299 <a href="#IsSubmit" title="details" class="method-name">IsSubmit</a>
300 ()
301 </div>
302
303 <div class="method-definition">
304 <img src="../../media/images/Method.png" alt=" "/>
305 <span class="method-result">void</span>
306 <a href="#IsUpdate" title="details" class="method-name">IsUpdate</a>
307 ()
308 </div>
309
310 <div class="method-definition">
311 <img src="../../media/images/Method.png" alt=" "/>
312 <span class="method-result">void</span>
313 <a href="#Layout" title="details" class="method-name">Layout</a>
314 (<span class="var-type"></span>&nbsp;<span class="var-name">$template</span>)
315 </div>
316
317 <div class="method-definition">
318 <img src="../../media/images/Method.png" alt=" "/>
319 <span class="method-result">void</span>
320 <a href="#MoreWhere" title="details" class="method-name">MoreWhere</a>
321 (<span class="var-type"></span>&nbsp;<span class="var-name">$operator</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$more_where</span>)
322 </div>
323
324 <div class="method-definition">
325 <img src="../../media/images/Method.png" alt=" "/>
326 <span class="method-result">void</span>
327 <a href="#OrWhere" title="details" class="method-name">OrWhere</a>
328 (<span class="var-type"></span>&nbsp;<span class="var-name">$more_where</span>)
329 </div>
330
331 <div class="method-definition">
332 <img src="../../media/images/Method.png" alt=" "/>
333 <span class="method-result">void</span>
334 <a href="#PostToValues" title="details" class="method-name">PostToValues</a>
335 ([<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
336 </div>
337
338 <div class="method-definition">
339 <img src="../../media/images/Method.png" alt=" "/>
340 <span class="method-result">void</span>
341 <a href="#Render" title="details" class="method-name">Render</a>
342 ([<span class="var-type"></span>&nbsp;<span class="var-name">$title_tag</span> = <span class="var-default">null</span>])
343 </div>
344
345 <div class="method-definition">
346 <img src="../../media/images/Method.png" alt=" "/>
347 <span class="method-result">string</span>
348 <a href="#ReplaceEditorPart" title="details" class="method-name">ReplaceEditorPart</a>
349 (<span class="var-type">array</span>&nbsp;<span class="var-name">$matches</span>)
350 </div>
351
352 <div class="method-definition">
353 <img src="../../media/images/Method.png" alt=" "/>
354 <span class="method-result">void</span>
355 <a href="#SetBaseTable" title="details" class="method-name">SetBaseTable</a>
356 (<span class="var-type"></span>&nbsp;<span class="var-name">$base_table</span>)
357 </div>
358
359 <div class="method-definition">
360 <img src="../../media/images/Method.png" alt=" "/>
361 <span class="method-result">void</span>
362 <a href="#SetJoins" title="details" class="method-name">SetJoins</a>
363 (<span class="var-type"></span>&nbsp;<span class="var-name">$join_list</span>)
364 </div>
365
366 <div class="method-definition">
367 <img src="../../media/images/Method.png" alt=" "/>
368 <span class="method-result">void</span>
369 <a href="#SetLookup" title="details" class="method-name">SetLookup</a>
370 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span>)
371 </div>
372
373 <div class="method-definition">
374 <img src="../../media/images/Method.png" alt=" "/>
375 <span class="method-result">void</span>
376 <a href="#SetOptionList" title="details" class="method-name">SetOptionList</a>
377 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$current</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
378 </div>
379
380 <div class="method-definition">
381 <img src="../../media/images/Method.png" alt=" "/>
382 <span class="method-result">void</span>
383 <a href="#SetRecord" title="details" class="method-name">SetRecord</a>
384 (<span class="var-type"></span>&nbsp;<span class="var-name">$row</span>)
385 </div>
386
387 <div class="method-definition">
388 <img src="../../media/images/Method.png" alt=" "/>
389 <span class="method-result">void</span>
390 <a href="#SetSql" title="details" class="method-name">SetSql</a>
391 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
392 </div>
393
394 <div class="method-definition">
395 <img src="../../media/images/Method.png" alt=" "/>
396 <span class="method-result">void</span>
397 <a href="#SetSubmitName" title="details" class="method-name">SetSubmitName</a>
398 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_submit</span>)
399 </div>
400
401 <div class="method-definition">
402 <img src="../../media/images/Method.png" alt=" "/>
403 <span class="method-result">void</span>
404 <a href="#SetTemplate" title="details" class="method-name">SetTemplate</a>
405 (<span class="var-type"></span>&nbsp;<span class="var-name">$template</span>)
406 </div>
407
408 <div class="method-definition">
409 <img src="../../media/images/Method.png" alt=" "/>
410 <span class="method-result">void</span>
411 <a href="#SetWhere" title="details" class="method-name">SetWhere</a>
412 (<span class="var-type"></span>&nbsp;<span class="var-name">$where_clause</span>)
413 </div>
414
415 <div class="method-definition">
416 <img src="../../media/images/Method.png" alt=" "/>
417 <span class="method-result">string</span>
418 <a href="#Title" title="details" class="method-name">Title</a>
419 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$new_title</span> = <span class="var-default">null</span>])
420 </div>
421
422 <div class="method-definition">
423 <img src="../../media/images/Method.png" alt=" "/>
424 <span class="method-result">void</span>
425 <a href="#Value" title="details" class="method-name">Value</a>
426 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value_field_name</span>)
427 </div>
428
429 <div class="method-definition">
430 <img src="../../media/images/Method.png" alt=" "/>
431 <span class="method-result">void</span>
432 <a href="#WhereNewRecord" title="details" class="method-name">WhereNewRecord</a>
433 (<span class="var-type"></span>&nbsp;<span class="var-name">$where_clause</span>)
434 </div>
435
436 <div class="method-definition">
437 <img src="../../media/images/Method.png" alt=" "/>
438 <span class="method-result">void</span>
439 <a href="#Write" title="details" class="method-name">Write</a>
440 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$is_update</span> = <span class="var-default">null</span>])
441 </div>
442 </div>
443 </div>
444 </div>
445
446 <a name="sec-vars"></a>
447 <div class="info-box">
448 <div class="info-box-title">Variables</div>
449 <div class="nav-bar">
450 <a href="#sec-description">Description</a> |
451 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
452
453
454 |
455 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
456
457 </div>
458 <div class="info-box-body">
459
460 <a name="var$Action" id="$Action"><!-- --></A>
461 <div class="evenrow">
462
463 <div class="var-header">
464 <img src="../../media/images/Variable.png" />
465 <span class="var-title">
466 <span class="var-type">mixed</span>
467 <span class="var-name">$Action</span>
468 (line <span class="line-number">105</span>)
469 </span>
470 </div>
471
472 <!-- ========== Info from phpDoc block ========= -->
473
474
475
476
477
478 </div>
479 <a name="var$BaseTable" id="$BaseTable"><!-- --></A>
480 <div class="oddrow">
481
482 <div class="var-header">
483 <img src="../../media/images/Variable.png" />
484 <span class="var-title">
485 <span class="var-type">mixed</span>
486 <span class="var-name">$BaseTable</span>
487 (line <span class="line-number">108</span>)
488 </span>
489 </div>
490
491 <!-- ========== Info from phpDoc block ========= -->
492
493
494
495
496
497 </div>
498 <a name="var$Fields" id="$Fields"><!-- --></A>
499 <div class="evenrow">
500
501 <div class="var-header">
502 <img src="../../media/images/Variable.png" />
503 <span class="var-title">
504 <span class="var-type">mixed</span>
505 <span class="var-name">$Fields</span>
506 (line <span class="line-number">106</span>)
507 </span>
508 </div>
509
510 <!-- ========== Info from phpDoc block ========= -->
511
512
513
514
515
516 </div>
517 <a name="var$Id" id="$Id"><!-- --></A>
518 <div class="oddrow">
519
520 <div class="var-header">
521 <img src="../../media/images/Variable.png" />
522 <span class="var-title">
523 <span class="var-type">mixed</span>
524 <span class="var-name">$Id</span>
525 (line <span class="line-number">119</span>)
526 </span>
527 </div>
528
529 <!-- ========== Info from phpDoc block ========= -->
530
531
532
533
534
535 </div>
536 <a name="var$Joins" id="$Joins"><!-- --></A>
537 <div class="evenrow">
538
539 <div class="var-header">
540 <img src="../../media/images/Variable.png" />
541 <span class="var-title">
542 <span class="var-type">mixed</span>
543 <span class="var-name">$Joins</span>
544 (line <span class="line-number">109</span>)
545 </span>
546 </div>
547
548 <!-- ========== Info from phpDoc block ========= -->
549
550
551
552
553
554 </div>
555 <a name="var$Limit" id="$Limit"><!-- --></A>
556 <div class="oddrow">
557
558 <div class="var-header">
559 <img src="../../media/images/Variable.png" />
560 <span class="var-title">
561 <span class="var-type">mixed</span>
562 <span class="var-name">$Limit</span>
563 (line <span class="line-number">113</span>)
564 </span>
565 </div>
566
567 <!-- ========== Info from phpDoc block ========= -->
568
569
570
571
572
573 </div>
574 <a name="var$NewWhere" id="$NewWhere"><!-- --></A>
575 <div class="evenrow">
576
577 <div class="var-header">
578 <img src="../../media/images/Variable.png" />
579 <span class="var-title">
580 <span class="var-type">mixed</span>
581 <span class="var-name">$NewWhere</span>
582 (line <span class="line-number">111</span>)
583 </span>
584 </div>
585
586 <!-- ========== Info from phpDoc block ========= -->
587
588
589
590
591
592 </div>
593 <a name="var$Order" id="$Order"><!-- --></A>
594 <div class="oddrow">
595
596 <div class="var-header">
597 <img src="../../media/images/Variable.png" />
598 <span class="var-title">
599 <span class="var-type">mixed</span>
600 <span class="var-name">$Order</span>
601 (line <span class="line-number">112</span>)
602 </span>
603 </div>
604
605 <!-- ========== Info from phpDoc block ========= -->
606
607
608
609
610
611 </div>
612 <a name="var$OrderedFields" id="$OrderedFields"><!-- --></A>
613 <div class="evenrow">
614
615 <div class="var-header">
616 <img src="../../media/images/Variable.png" />
617 <span class="var-title">
618 <span class="var-type">mixed</span>
619 <span class="var-name">$OrderedFields</span>
620 (line <span class="line-number">107</span>)
621 </span>
622 </div>
623
624 <!-- ========== Info from phpDoc block ========= -->
625
626
627
628
629
630 </div>
631 <a name="var$Query" id="$Query"><!-- --></A>
632 <div class="oddrow">
633
634 <div class="var-header">
635 <img src="../../media/images/Variable.png" />
636 <span class="var-title">
637 <span class="var-type">mixed</span>
638 <span class="var-name">$Query</span>
639 (line <span class="line-number">114</span>)
640 </span>
641 </div>
642
643 <!-- ========== Info from phpDoc block ========= -->
644
645
646
647
648
649 </div>
650 <a name="var$Record" id="$Record"><!-- --></A>
651 <div class="evenrow">
652
653 <div class="var-header">
654 <img src="../../media/images/Variable.png" />
655 <span class="var-title">
656 <span class="var-type">mixed</span>
657 <span class="var-name">$Record</span>
658 (line <span class="line-number">117</span>)
659 </span>
660 </div>
661
662 <!-- ========== Info from phpDoc block ========= -->
663
664
665
666
667
668 </div>
669 <a name="var$RecordAvailable" id="$RecordAvailable"><!-- --></A>
670 <div class="oddrow">
671
672 <div class="var-header">
673 <img src="../../media/images/Variable.png" />
674 <span class="var-title">
675 <span class="var-type">mixed</span>
676 <span class="var-name">$RecordAvailable</span>
677 (line <span class="line-number">116</span>)
678 </span>
679 </div>
680
681 <!-- ========== Info from phpDoc block ========= -->
682
683
684
685
686
687 </div>
688 <a name="var$SubmitName" id="$SubmitName"><!-- --></A>
689 <div class="evenrow">
690
691 <div class="var-header">
692 <img src="../../media/images/Variable.png" />
693 <span class="var-title">
694 <span class="var-type">mixed</span>
695 <span class="var-name">$SubmitName</span>
696 (line <span class="line-number">118</span>)
697 </span>
698 </div>
699
700 <!-- ========== Info from phpDoc block ========= -->
701
702
703
704
705
706 </div>
707 <a name="var$Template" id="$Template"><!-- --></A>
708 <div class="oddrow">
709
710 <div class="var-header">
711 <img src="../../media/images/Variable.png" />
712 <span class="var-title">
713 <span class="var-type">mixed</span>
714 <span class="var-name">$Template</span>
715 (line <span class="line-number">115</span>)
716 </span>
717 </div>
718
719 <!-- ========== Info from phpDoc block ========= -->
720
721
722
723
724
725 </div>
726 <a name="var$Title" id="$Title"><!-- --></A>
727 <div class="evenrow">
728
729 <div class="var-header">
730 <img src="../../media/images/Variable.png" />
731 <span class="var-title">
732 <span class="var-type">mixed</span>
733 <span class="var-name">$Title</span>
734 (line <span class="line-number">104</span>)
735 </span>
736 </div>
737
738 <!-- ========== Info from phpDoc block ========= -->
739
740
741
742
743
744 </div>
745 <a name="var$Where" id="$Where"><!-- --></A>
746 <div class="oddrow">
747
748 <div class="var-header">
749 <img src="../../media/images/Variable.png" />
750 <span class="var-title">
751 <span class="var-type">mixed</span>
752 <span class="var-name">$Where</span>
753 (line <span class="line-number">110</span>)
754 </span>
755 </div>
756
757 <!-- ========== Info from phpDoc block ========= -->
758
759
760
761
762
763 </div>
764
765 </div>
766 </div>
767
768 <a name="sec-methods"></a>
769 <div class="info-box">
770 <div class="info-box-title">Methods</div>
771 <div class="nav-bar">
772 <a href="#sec-description">Description</a> |
773 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
774 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
775
776 </div>
777 <div class="info-box-body">
778 <A NAME='method_detail'></A>
779 <a name="method__construct" id="__construct"><!-- --></a>
780 <div class="evenrow">
781
782 <div class="method-header">
783 <img src="../../media/images/Constructor.png" />
784 <span class="method-title">Constructor __construct</span> (line <span class="line-number">121</span>)
785 </div>
786
787 <!-- ========== Info from phpDoc block ========= -->
788
789 <div class="method-signature">
790 <span class="method-result">Editor</span>
791 <span class="method-name">
792 __construct
793 </span>
794 ([<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fields</span> = <span class="var-default">null</span>])
795 </div>
796
797 <ul class="parameters">
798 <li>
799 <span class="var-type"></span>
800 <span class="var-name">$title</span> </li>
801 <li>
802 <span class="var-type"></span>
803 <span class="var-name">$fields</span> </li>
804 </ul>
805
806
807 </div>
808 <a name="methodAddAttribute" id="AddAttribute"><!-- --></a>
809 <div class="oddrow">
810
811 <div class="method-header">
812 <img src="../../media/images/Method.png" />
813 <span class="method-title">AddAttribute</span> (line <span class="line-number">198</span>)
814 </div>
815
816 <!-- ========== Info from phpDoc block ========= -->
817
818 <div class="method-signature">
819 <span class="method-result">void</span>
820 <span class="method-name">
821 AddAttribute
822 </span>
823 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$k</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$v</span>)
824 </div>
825
826 <ul class="parameters">
827 <li>
828 <span class="var-type"></span>
829 <span class="var-name">$field</span> </li>
830 <li>
831 <span class="var-type"></span>
832 <span class="var-name">$k</span> </li>
833 <li>
834 <span class="var-type"></span>
835 <span class="var-name">$v</span> </li>
836 </ul>
837
838
839 </div>
840 <a name="methodAddField" id="AddField"><!-- --></a>
841 <div class="evenrow">
842
843 <div class="method-header">
844 <img src="../../media/images/Method.png" />
845 <span class="method-title">AddField</span> (line <span class="line-number">150</span>)
846 </div>
847
848 <!-- ========== Info from phpDoc block ========= -->
849
850 <div class="method-signature">
851 <span class="method-result">void</span>
852 <span class="method-name">
853 &amp;AddField
854 </span>
855 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span> = <span class="var-default">&quot;&quot;</span>])
856 </div>
857
858 <ul class="parameters">
859 <li>
860 <span class="var-type"></span>
861 <span class="var-name">$field</span> </li>
862 <li>
863 <span class="var-type"></span>
864 <span class="var-name">$sql</span> </li>
865 <li>
866 <span class="var-type"></span>
867 <span class="var-name">$lookup_sql</span> </li>
868 </ul>
869
870
871 </div>
872 <a name="methodAndWhere" id="AndWhere"><!-- --></a>
873 <div class="oddrow">
874
875 <div class="method-header">
876 <img src="../../media/images/Method.png" />
877 <span class="method-title">AndWhere</span> (line <span class="line-number">261</span>)
878 </div>
879
880 <!-- ========== Info from phpDoc block ========= -->
881
882 <div class="method-signature">
883 <span class="method-result">void</span>
884 <span class="method-name">
885 AndWhere
886 </span>
887 (<span class="var-type"></span>&nbsp;<span class="var-name">$more_where</span>)
888 </div>
889
890 <ul class="parameters">
891 <li>
892 <span class="var-type"></span>
893 <span class="var-name">$more_where</span> </li>
894 </ul>
895
896
897 </div>
898 <a name="methodAssign" id="Assign"><!-- --></a>
899 <div class="evenrow">
900
901 <div class="method-header">
902 <img src="../../media/images/Method.png" />
903 <span class="method-title">Assign</span> (line <span class="line-number">180</span>)
904 </div>
905
906 <!-- ========== Info from phpDoc block ========= -->
907 <p class="short-description">Assigns the value of a field in the record currently associated with this editor.</p>
908
909 <div class="method-signature">
910 <span class="method-result">void</span>
911 <span class="method-name">
912 Assign
913 </span>
914 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value_field_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$new_value</span>)
915 </div>
916
917 <ul class="parameters">
918 <li>
919 <span class="var-type">string</span>
920 <span class="var-name">$value_field_name</span> </li>
921 <li>
922 <span class="var-type">string</span>
923 <span class="var-name">$new_value</span> </li>
924 </ul>
925
926
927 </div>
928 <a name="methodAvailable" id="Available"><!-- --></a>
929 <div class="oddrow">
930
931 <div class="method-header">
932 <img src="../../media/images/Method.png" />
933 <span class="method-title">Available</span> (line <span class="line-number">279</span>)
934 </div>
935
936 <!-- ========== Info from phpDoc block ========= -->
937
938 <div class="method-signature">
939 <span class="method-result">void</span>
940 <span class="method-name">
941 Available
942 </span>
943 ()
944 </div>
945
946
947
948 </div>
949 <a name="methodGetRecord" id="GetRecord"><!-- --></a>
950 <div class="evenrow">
951
952 <div class="method-header">
953 <img src="../../media/images/Method.png" />
954 <span class="method-title">GetRecord</span> (line <span class="line-number">317</span>)
955 </div>
956
957 <!-- ========== Info from phpDoc block ========= -->
958
959 <div class="method-signature">
960 <span class="method-result">void</span>
961 <span class="method-name">
962 GetRecord
963 </span>
964 ([<span class="var-type"></span>&nbsp;<span class="var-name">$where</span> = <span class="var-default">&quot;&quot;</span>])
965 </div>
966
967 <ul class="parameters">
968 <li>
969 <span class="var-type"></span>
970 <span class="var-name">$where</span> </li>
971 </ul>
972
973
974 </div>
975 <a name="methodId" id="Id"><!-- --></a>
976 <div class="oddrow">
977
978 <div class="method-header">
979 <img src="../../media/images/Method.png" />
980 <span class="method-title">Id</span> (line <span class="line-number">189</span>)
981 </div>
982
983 <!-- ========== Info from phpDoc block ========= -->
984 <p class="short-description">Sets or returns the form ID used for differentiating this form from others in the page.</p>
985
986 <div class="method-signature">
987 <span class="method-result">void</span>
988 <span class="method-name">
989 Id
990 </span>
991 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
992 </div>
993
994 <ul class="parameters">
995 <li>
996 <span class="var-type">string</span>
997 <span class="var-name">$id</span> </li>
998 </ul>
999
1000
1001 </div>
1002 <a name="methodInitialise" id="Initialise"><!-- --></a>
1003 <div class="evenrow">
1004
1005 <div class="method-header">
1006 <img src="../../media/images/Method.png" />
1007 <span class="method-title">Initialise</span> (line <span class="line-number">294</span>)
1008 </div>
1009
1010 <!-- ========== Info from phpDoc block ========= -->
1011 <p class="short-description">Set some particular values to the ones from the array.</p>
1012
1013 <div class="method-signature">
1014 <span class="method-result">void</span>
1015 <span class="method-name">
1016 Initialise
1017 </span>
1018 (<span class="var-type">array</span>&nbsp;<span class="var-name">$values</span>)
1019 </div>
1020
1021 <ul class="parameters">
1022 <li>
1023 <span class="var-type">array</span>
1024 <span class="var-name">$values</span><span class="var-description">: An array of fieldname / value pairs</span> </li>
1025 </ul>
1026
1027
1028 </div>
1029 <a name="methodIsCreate" id="IsCreate"><!-- --></a>
1030 <div class="oddrow">
1031
1032 <div class="method-header">
1033 <img src="../../media/images/Method.png" />
1034 <span class="method-title">IsCreate</span> (line <span class="line-number">241</span>)
1035 </div>
1036
1037 <!-- ========== Info from phpDoc block ========= -->
1038
1039 <div class="method-signature">
1040 <span class="method-result">void</span>
1041 <span class="method-name">
1042 IsCreate
1043 </span>
1044 ()
1045 </div>
1046
1047
1048
1049 </div>
1050 <a name="methodIsSubmit" id="IsSubmit"><!-- --></a>
1051 <div class="evenrow">
1052
1053 <div class="method-header">
1054 <img src="../../media/images/Method.png" />
1055 <span class="method-title">IsSubmit</span> (line <span class="line-number">228</span>)
1056 </div>
1057
1058 <!-- ========== Info from phpDoc block ========= -->
1059
1060 <div class="method-signature">
1061 <span class="method-result">void</span>
1062 <span class="method-name">
1063 IsSubmit
1064 </span>
1065 ()
1066 </div>
1067
1068
1069
1070 </div>
1071 <a name="methodIsUpdate" id="IsUpdate"><!-- --></a>
1072 <div class="oddrow">
1073
1074 <div class="method-header">
1075 <img src="../../media/images/Method.png" />
1076 <span class="method-title">IsUpdate</span> (line <span class="line-number">232</span>)
1077 </div>
1078
1079 <!-- ========== Info from phpDoc block ========= -->
1080
1081 <div class="method-signature">
1082 <span class="method-result">void</span>
1083 <span class="method-name">
1084 IsUpdate
1085 </span>
1086 ()
1087 </div>
1088
1089
1090
1091 </div>
1092 <a name="methodLayout" id="Layout"><!-- --></a>
1093 <div class="evenrow">
1094
1095 <div class="method-header">
1096 <img src="../../media/images/Method.png" />
1097 <span class="method-title">Layout</span> (line <span class="line-number">273</span>)
1098 </div>
1099
1100 <!-- ========== Info from phpDoc block ========= -->
1101
1102 <div class="method-signature">
1103 <span class="method-result">void</span>
1104 <span class="method-name">
1105 Layout
1106 </span>
1107 (<span class="var-type"></span>&nbsp;<span class="var-name">$template</span>)
1108 </div>
1109
1110 <ul class="parameters">
1111 <li>
1112 <span class="var-type"></span>
1113 <span class="var-name">$template</span> </li>
1114 </ul>
1115
1116
1117 </div>
1118 <a name="methodMoreWhere" id="MoreWhere"><!-- --></a>
1119 <div class="oddrow">
1120
1121 <div class="method-header">
1122 <img src="../../media/images/Method.png" />
1123 <span class="method-title">MoreWhere</span> (line <span class="line-number">253</span>)
1124 </div>
1125
1126 <!-- ========== Info from phpDoc block ========= -->
1127
1128 <div class="method-signature">
1129 <span class="method-result">void</span>
1130 <span class="method-name">
1131 MoreWhere
1132 </span>
1133 (<span class="var-type"></span>&nbsp;<span class="var-name">$operator</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$more_where</span>)
1134 </div>
1135
1136 <ul class="parameters">
1137 <li>
1138 <span class="var-type"></span>
1139 <span class="var-name">$operator</span> </li>
1140 <li>
1141 <span class="var-type"></span>
1142 <span class="var-name">$more_where</span> </li>
1143 </ul>
1144
1145
1146 </div>
1147 <a name="methodOrWhere" id="OrWhere"><!-- --></a>
1148 <div class="evenrow">
1149
1150 <div class="method-header">
1151 <img src="../../media/images/Method.png" />
1152 <span class="method-title">OrWhere</span> (line <span class="line-number">265</span>)
1153 </div>
1154
1155 <!-- ========== Info from phpDoc block ========= -->
1156
1157 <div class="method-signature">
1158 <span class="method-result">void</span>
1159 <span class="method-name">
1160 OrWhere
1161 </span>
1162 (<span class="var-type"></span>&nbsp;<span class="var-name">$more_where</span>)
1163 </div>
1164
1165 <ul class="parameters">
1166 <li>
1167 <span class="var-type"></span>
1168 <span class="var-name">$more_where</span> </li>
1169 </ul>
1170
1171
1172 </div>
1173 <a name="methodPostToValues" id="PostToValues"><!-- --></a>
1174 <div class="oddrow">
1175
1176 <div class="method-header">
1177 <img src="../../media/images/Method.png" />
1178 <span class="method-title">PostToValues</span> (line <span class="line-number">307</span>)
1179 </div>
1180
1181 <!-- ========== Info from phpDoc block ========= -->
1182 <p class="short-description">This will assign $_POST values to the internal Values object for each field that exists in the Fields array.</p>
1183
1184 <div class="method-signature">
1185 <span class="method-result">void</span>
1186 <span class="method-name">
1187 PostToValues
1188 </span>
1189 ([<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
1190 </div>
1191
1192 <ul class="parameters">
1193 <li>
1194 <span class="var-type"></span>
1195 <span class="var-name">$prefix</span> </li>
1196 </ul>
1197
1198
1199 </div>
1200 <a name="methodRender" id="Render"><!-- --></a>
1201 <div class="evenrow">
1202
1203 <div class="method-header">
1204 <img src="../../media/images/Method.png" />
1205 <span class="method-title">Render</span> (line <span class="line-number">463</span>)
1206 </div>
1207
1208 <!-- ========== Info from phpDoc block ========= -->
1209 <p class="short-description">Render the templated component. The heavy lifting is done by the callback...</p>
1210
1211 <div class="method-signature">
1212 <span class="method-result">void</span>
1213 <span class="method-name">
1214 Render
1215 </span>
1216 ([<span class="var-type"></span>&nbsp;<span class="var-name">$title_tag</span> = <span class="var-default">null</span>])
1217 </div>
1218
1219 <ul class="parameters">
1220 <li>
1221 <span class="var-type"></span>
1222 <span class="var-name">$title_tag</span> </li>
1223 </ul>
1224
1225
1226 </div>
1227 <a name="methodReplaceEditorPart" id="ReplaceEditorPart"><!-- --></a>
1228 <div class="oddrow">
1229
1230 <div class="method-header">
1231 <img src="../../media/images/Method.png" />
1232 <span class="method-title">ReplaceEditorPart</span> (line <span class="line-number">345</span>)
1233 </div>
1234
1235 <!-- ========== Info from phpDoc block ========= -->
1236 <p class="short-description">Replace parts into the form template.</p>
1237 <ul class="tags">
1238 <li><span class="field">return:</span> What we want to replace this match with.</li>
1239 </ul>
1240
1241 <div class="method-signature">
1242 <span class="method-result">string</span>
1243 <span class="method-name">
1244 ReplaceEditorPart
1245 </span>
1246 (<span class="var-type">array</span>&nbsp;<span class="var-name">$matches</span>)
1247 </div>
1248
1249 <ul class="parameters">
1250 <li>
1251 <span class="var-type">array</span>
1252 <span class="var-name">$matches</span><span class="var-description">: The matches found which preg_replace_callback is calling us for.</span> </li>
1253 </ul>
1254
1255
1256 </div>
1257 <a name="methodSetBaseTable" id="SetBaseTable"><!-- --></a>
1258 <div class="evenrow">
1259
1260 <div class="method-header">
1261 <img src="../../media/images/Method.png" />
1262 <span class="method-title">SetBaseTable</span> (line <span class="line-number">203</span>)
1263 </div>
1264
1265 <!-- ========== Info from phpDoc block ========= -->
1266
1267 <div class="method-signature">
1268 <span class="method-result">void</span>
1269 <span class="method-name">
1270 SetBaseTable
1271 </span>
1272 (<span class="var-type"></span>&nbsp;<span class="var-name">$base_table</span>)
1273 </div>
1274
1275 <ul class="parameters">
1276 <li>
1277 <span class="var-type"></span>
1278 <span class="var-name">$base_table</span> </li>
1279 </ul>
1280
1281
1282 </div>
1283 <a name="methodSetJoins" id="SetJoins"><!-- --></a>
1284 <div class="oddrow">
1285
1286 <div class="method-header">
1287 <img src="../../media/images/Method.png" />
1288 <span class="method-title">SetJoins</span> (line <span class="line-number">207</span>)
1289 </div>
1290
1291 <!-- ========== Info from phpDoc block ========= -->
1292
1293 <div class="method-signature">
1294 <span class="method-result">void</span>
1295 <span class="method-name">
1296 SetJoins
1297 </span>
1298 (<span class="var-type"></span>&nbsp;<span class="var-name">$join_list</span>)
1299 </div>
1300
1301 <ul class="parameters">
1302 <li>
1303 <span class="var-type"></span>
1304 <span class="var-name">$join_list</span> </li>
1305 </ul>
1306
1307
1308 </div>
1309 <a name="methodSetLookup" id="SetLookup"><!-- --></a>
1310 <div class="evenrow">
1311
1312 <div class="method-header">
1313 <img src="../../media/images/Method.png" />
1314 <span class="method-title">SetLookup</span> (line <span class="line-number">160</span>)
1315 </div>
1316
1317 <!-- ========== Info from phpDoc block ========= -->
1318
1319 <div class="method-signature">
1320 <span class="method-result">void</span>
1321 <span class="method-name">
1322 SetLookup
1323 </span>
1324 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span>)
1325 </div>
1326
1327 <ul class="parameters">
1328 <li>
1329 <span class="var-type"></span>
1330 <span class="var-name">$field</span> </li>
1331 <li>
1332 <span class="var-type"></span>
1333 <span class="var-name">$lookup_sql</span> </li>
1334 </ul>
1335
1336
1337 </div>
1338 <a name="methodSetOptionList" id="SetOptionList"><!-- --></a>
1339 <div class="oddrow">
1340
1341 <div class="method-header">
1342 <img src="../../media/images/Method.png" />
1343 <span class="method-title">SetOptionList</span> (line <span class="line-number">194</span>)
1344 </div>
1345
1346 <!-- ========== Info from phpDoc block ========= -->
1347
1348 <div class="method-signature">
1349 <span class="method-result">void</span>
1350 <span class="method-name">
1351 SetOptionList
1352 </span>
1353 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$current</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
1354 </div>
1355
1356 <ul class="parameters">
1357 <li>
1358 <span class="var-type"></span>
1359 <span class="var-name">$field</span> </li>
1360 <li>
1361 <span class="var-type"></span>
1362 <span class="var-name">$options</span> </li>
1363 <li>
1364 <span class="var-type"></span>
1365 <span class="var-name">$current</span> </li>
1366 <li>
1367 <span class="var-type"></span>
1368 <span class="var-name">$parameters</span> </li>
1369 </ul>
1370
1371
1372 </div>
1373 <a name="methodSetRecord" id="SetRecord"><!-- --></a>
1374 <div class="evenrow">
1375
1376 <div class="method-header">
1377 <img src="../../media/images/Method.png" />
1378 <span class="method-title">SetRecord</span> (line <span class="line-number">283</span>)
1379 </div>
1380
1381 <!-- ========== Info from phpDoc block ========= -->
1382
1383 <div class="method-signature">
1384 <span class="method-result">void</span>
1385 <span class="method-name">
1386 SetRecord
1387 </span>
1388 (<span class="var-type"></span>&nbsp;<span class="var-name">$row</span>)
1389 </div>
1390
1391 <ul class="parameters">
1392 <li>
1393 <span class="var-type"></span>
1394 <span class="var-name">$row</span> </li>
1395 </ul>
1396
1397
1398 </div>
1399 <a name="methodSetSql" id="SetSql"><!-- --></a>
1400 <div class="oddrow">
1401
1402 <div class="method-header">
1403 <img src="../../media/images/Method.png" />
1404 <span class="method-title">SetSql</span> (line <span class="line-number">156</span>)
1405 </div>
1406
1407 <!-- ========== Info from phpDoc block ========= -->
1408
1409 <div class="method-signature">
1410 <span class="method-result">void</span>
1411 <span class="method-name">
1412 SetSql
1413 </span>
1414 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
1415 </div>
1416
1417 <ul class="parameters">
1418 <li>
1419 <span class="var-type"></span>
1420 <span class="var-name">$field</span> </li>
1421 <li>
1422 <span class="var-type"></span>
1423 <span class="var-name">$sql</span> </li>
1424 </ul>
1425
1426
1427 </div>
1428 <a name="methodSetSubmitName" id="SetSubmitName"><!-- --></a>
1429 <div class="evenrow">
1430
1431 <div class="method-header">
1432 <img src="../../media/images/Method.png" />
1433 <span class="method-title">SetSubmitName</span> (line <span class="line-number">224</span>)
1434 </div>
1435
1436 <!-- ========== Info from phpDoc block ========= -->
1437
1438 <div class="method-signature">
1439 <span class="method-result">void</span>
1440 <span class="method-name">
1441 SetSubmitName
1442 </span>
1443 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_submit</span>)
1444 </div>
1445
1446 <ul class="parameters">
1447 <li>
1448 <span class="var-type"></span>
1449 <span class="var-name">$new_submit</span> </li>
1450 </ul>
1451
1452
1453 </div>
1454 <a name="methodSetTemplate" id="SetTemplate"><!-- --></a>
1455 <div class="oddrow">
1456
1457 <div class="method-header">
1458 <img src="../../media/images/Method.png" />
1459 <span class="method-title">SetTemplate</span> (line <span class="line-number">269</span>)
1460 </div>
1461
1462 <!-- ========== Info from phpDoc block ========= -->
1463
1464 <div class="method-signature">
1465 <span class="method-result">void</span>
1466 <span class="method-name">
1467 SetTemplate
1468 </span>
1469 (<span class="var-type"></span>&nbsp;<span class="var-name">$template</span>)
1470 </div>
1471
1472 <ul class="parameters">
1473 <li>
1474 <span class="var-type"></span>
1475 <span class="var-name">$template</span> </li>
1476 </ul>
1477
1478
1479 </div>
1480 <a name="methodSetWhere" id="SetWhere"><!-- --></a>
1481 <div class="evenrow">
1482
1483 <div class="method-header">
1484 <img src="../../media/images/Method.png" />
1485 <span class="method-title">SetWhere</span> (line <span class="line-number">245</span>)
1486 </div>
1487
1488 <!-- ========== Info from phpDoc block ========= -->
1489
1490 <div class="method-signature">
1491 <span class="method-result">void</span>
1492 <span class="method-name">
1493 SetWhere
1494 </span>
1495 (<span class="var-type"></span>&nbsp;<span class="var-name">$where_clause</span>)
1496 </div>
1497
1498 <ul class="parameters">
1499 <li>
1500 <span class="var-type"></span>
1501 <span class="var-name">$where_clause</span> </li>
1502 </ul>
1503
1504
1505 </div>
1506 <a name="methodTitle" id="Title"><!-- --></a>
1507 <div class="oddrow">
1508
1509 <div class="method-header">
1510 <img src="../../media/images/Method.png" />
1511 <span class="method-title">Title</span> (line <span class="line-number">218</span>)
1512 </div>
1513
1514 <!-- ========== Info from phpDoc block ========= -->
1515 <p class="short-description">Accessor for the Title for the browse, which could set the title also.</p>
1516 <ul class="tags">
1517 <li><span class="field">return:</span> The current title for the browser</li>
1518 </ul>
1519
1520 <div class="method-signature">
1521 <span class="method-result">string</span>
1522 <span class="method-name">
1523 Title
1524 </span>
1525 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$new_title</span> = <span class="var-default">null</span>])
1526 </div>
1527
1528 <ul class="parameters">
1529 <li>
1530 <span class="var-type">string</span>
1531 <span class="var-name">$new_title</span><span class="var-description">: The new title for the browser</span> </li>
1532 </ul>
1533
1534
1535 </div>
1536 <a name="methodValue" id="Value"><!-- --></a>
1537 <div class="evenrow">
1538
1539 <div class="method-header">
1540 <img src="../../media/images/Method.png" />
1541 <span class="method-title">Value</span> (line <span class="line-number">170</span>)
1542 </div>
1543
1544 <!-- ========== Info from phpDoc block ========= -->
1545 <p class="short-description">Gets the value of a field in the record currently assigned to this editor.</p>
1546
1547 <div class="method-signature">
1548 <span class="method-result">void</span>
1549 <span class="method-name">
1550 Value
1551 </span>
1552 (<span class="var-type">string</span>&nbsp;<span class="var-name">$value_field_name</span>)
1553 </div>
1554
1555 <ul class="parameters">
1556 <li>
1557 <span class="var-type">string</span>
1558 <span class="var-name">$value_field_name</span> </li>
1559 </ul>
1560
1561
1562 </div>
1563 <a name="methodWhereNewRecord" id="WhereNewRecord"><!-- --></a>
1564 <div class="oddrow">
1565
1566 <div class="method-header">
1567 <img src="../../media/images/Method.png" />
1568 <span class="method-title">WhereNewRecord</span> (line <span class="line-number">249</span>)
1569 </div>
1570
1571 <!-- ========== Info from phpDoc block ========= -->
1572
1573 <div class="method-signature">
1574 <span class="method-result">void</span>
1575 <span class="method-name">
1576 WhereNewRecord
1577 </span>
1578 (<span class="var-type"></span>&nbsp;<span class="var-name">$where_clause</span>)
1579 </div>
1580
1581 <ul class="parameters">
1582 <li>
1583 <span class="var-type"></span>
1584 <span class="var-name">$where_clause</span> </li>
1585 </ul>
1586
1587
1588 </div>
1589 <a name="methodWrite" id="Write"><!-- --></a>
1590 <div class="evenrow">
1591
1592 <div class="method-header">
1593 <img src="../../media/images/Method.png" />
1594 <span class="method-title">Write</span> (line <span class="line-number">486</span>)
1595 </div>
1596
1597 <!-- ========== Info from phpDoc block ========= -->
1598 <p class="short-description">Write the record</p>
1599
1600 <div class="method-signature">
1601 <span class="method-result">void</span>
1602 <span class="method-name">
1603 Write
1604 </span>
1605 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$is_update</span> = <span class="var-default">null</span>])
1606 </div>
1607
1608 <ul class="parameters">
1609 <li>
1610 <span class="var-type">boolean</span>
1611 <span class="var-name">$is_update</span><span class="var-description">: Tell the write whether it's an update or insert. Hopefully it should be able to figure it out though.</span> </li>
1612 </ul>
1613
1614
1615 </div>
1616
1617 </div>
1618 </div>
1619
1620
1621 <p class="notes" id="credit">
1622 Documentation generated on Tue, 28 Dec 2010 02:01:35 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
1623 </p>
1624 </div></body>
1625 </html>
Andrew's Web Libraries