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 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";
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"> Editor
</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-var-summary">Vars
</a> (
<a href=
"#sec-vars">details
</a>)
99 |
<a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
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>
106 Located in
<a class=
"field" href=
"_classEditor.php.html">/classEditor.php
</a> (line
<span class=
"field">111</span>)
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>)
124 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>)
221 <span class=
"disabled">Methods
</span> (
<a href=
"#sec-methods">details
</a>)
223 <div class=
"info-box-body">
224 <div class=
"method-summary">
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> <span class=
"var-name">$title
</span> =
<span class=
"var-default">""</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$fields
</span> =
<span class=
"var-default">null
</span>])
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> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$k
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$v
</span>)
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">&AddField
</a>
244 (
<span class=
"var-type"></span> <span class=
"var-name">$field
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$sql
</span> =
<span class=
"var-default">""</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$lookup_sql
</span> =
<span class=
"var-default">""</span>])
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> <span class=
"var-name">$more_where
</span>)
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> <span class=
"var-name">$value_field_name
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$new_value
</span>)
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>
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> <span class=
"var-name">$where
</span> =
<span class=
"var-default">""</span>])
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> <span class=
"var-name">$id
</span> =
<span class=
"var-default">null
</span>])
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> <span class=
"var-name">$values
</span>)
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>
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>
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>
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> <span class=
"var-name">$template
</span>)
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> <span class=
"var-name">$operator
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$more_where
</span>)
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> <span class=
"var-name">$more_where
</span>)
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> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">''
</span>])
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> <span class=
"var-name">$title_tag
</span> =
<span class=
"var-default">null
</span>])
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> <span class=
"var-name">$matches
</span>)
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> <span class=
"var-name">$base_table
</span>)
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> <span class=
"var-name">$join_list
</span>)
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> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$lookup_sql
</span>)
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> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$options
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$current
</span> =
<span class=
"var-default">null
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$parameters
</span> =
<span class=
"var-default">null
</span>])
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> <span class=
"var-name">$row
</span>)
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> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$sql
</span>)
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> <span class=
"var-name">$new_submit
</span>)
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> <span class=
"var-name">$template
</span>)
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> <span class=
"var-name">$where_clause
</span>)
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> <span class=
"var-name">$new_title
</span> =
<span class=
"var-default">null
</span>])
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> <span class=
"var-name">$value_field_name
</span>)
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> <span class=
"var-name">$where_clause
</span>)
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> <span class=
"var-name">$is_update
</span> =
<span class=
"var-default">null
</span>])
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>)
455 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
458 <div class=
"info-box-body">
460 <a name=
"var$Action" id=
"$Action"><!-- --></A>
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">114</span>)
472 <!-- ========== Info from phpDoc block ========= -->
479 <a name=
"var$BaseTable" id=
"$BaseTable"><!-- --></A>
480 <div class=
"evenrow">
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">117</span>)
491 <!-- ========== Info from phpDoc block ========= -->
498 <a name=
"var$Fields" id=
"$Fields"><!-- --></A>
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">115</span>)
510 <!-- ========== Info from phpDoc block ========= -->
517 <a name=
"var$Id" id=
"$Id"><!-- --></A>
518 <div class=
"evenrow">
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">128</span>)
529 <!-- ========== Info from phpDoc block ========= -->
536 <a name=
"var$Joins" id=
"$Joins"><!-- --></A>
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">118</span>)
548 <!-- ========== Info from phpDoc block ========= -->
555 <a name=
"var$Limit" id=
"$Limit"><!-- --></A>
556 <div class=
"evenrow">
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">122</span>)
567 <!-- ========== Info from phpDoc block ========= -->
574 <a name=
"var$NewWhere" id=
"$NewWhere"><!-- --></A>
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">120</span>)
586 <!-- ========== Info from phpDoc block ========= -->
593 <a name=
"var$Order" id=
"$Order"><!-- --></A>
594 <div class=
"evenrow">
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">121</span>)
605 <!-- ========== Info from phpDoc block ========= -->
612 <a name=
"var$OrderedFields" id=
"$OrderedFields"><!-- --></A>
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">116</span>)
624 <!-- ========== Info from phpDoc block ========= -->
631 <a name=
"var$Query" id=
"$Query"><!-- --></A>
632 <div class=
"evenrow">
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">123</span>)
643 <!-- ========== Info from phpDoc block ========= -->
650 <a name=
"var$Record" id=
"$Record"><!-- --></A>
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">126</span>)
662 <!-- ========== Info from phpDoc block ========= -->
669 <a name=
"var$RecordAvailable" id=
"$RecordAvailable"><!-- --></A>
670 <div class=
"evenrow">
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">125</span>)
681 <!-- ========== Info from phpDoc block ========= -->
688 <a name=
"var$SubmitName" id=
"$SubmitName"><!-- --></A>
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">127</span>)
700 <!-- ========== Info from phpDoc block ========= -->
707 <a name=
"var$Template" id=
"$Template"><!-- --></A>
708 <div class=
"evenrow">
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">124</span>)
719 <!-- ========== Info from phpDoc block ========= -->
726 <a name=
"var$Title" id=
"$Title"><!-- --></A>
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">113</span>)
738 <!-- ========== Info from phpDoc block ========= -->
745 <a name=
"var$Where" id=
"$Where"><!-- --></A>
746 <div class=
"evenrow">
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">119</span>)
757 <!-- ========== Info from phpDoc block ========= -->
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>)
777 <div class=
"info-box-body">
778 <A NAME='method_detail'
></A>
779 <a name=
"method__construct" id=
"__construct"><!-- --></a>
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">130</span>)
787 <!-- ========== Info from phpDoc block ========= -->
789 <div class=
"method-signature">
790 <span class=
"method-result">Editor
</span>
791 <span class=
"method-name">
794 ([
<span class=
"var-type"></span> <span class=
"var-name">$title
</span> =
<span class=
"var-default">""</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$fields
</span> =
<span class=
"var-default">null
</span>])
797 <ul class=
"parameters">
799 <span class=
"var-type"></span>
800 <span class=
"var-name">$title
</span> </li>
802 <span class=
"var-type"></span>
803 <span class=
"var-name">$fields
</span> </li>
808 <a name=
"methodAddAttribute" id=
"AddAttribute"><!-- --></a>
809 <div class=
"evenrow">
811 <div class=
"method-header">
812 <img src=
"../../media/images/Method.png" />
813 <span class=
"method-title">AddAttribute
</span> (line
<span class=
"line-number">207</span>)
816 <!-- ========== Info from phpDoc block ========= -->
818 <div class=
"method-signature">
819 <span class=
"method-result">void
</span>
820 <span class=
"method-name">
823 (
<span class=
"var-type"></span> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$k
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$v
</span>)
826 <ul class=
"parameters">
828 <span class=
"var-type"></span>
829 <span class=
"var-name">$field
</span> </li>
831 <span class=
"var-type"></span>
832 <span class=
"var-name">$k
</span> </li>
834 <span class=
"var-type"></span>
835 <span class=
"var-name">$v
</span> </li>
840 <a name=
"methodAddField" id=
"AddField"><!-- --></a>
843 <div class=
"method-header">
844 <img src=
"../../media/images/Method.png" />
845 <span class=
"method-title">AddField
</span> (line
<span class=
"line-number">159</span>)
848 <!-- ========== Info from phpDoc block ========= -->
850 <div class=
"method-signature">
851 <span class=
"method-result">void
</span>
852 <span class=
"method-name">
855 (
<span class=
"var-type"></span> <span class=
"var-name">$field
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$sql
</span> =
<span class=
"var-default">""</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$lookup_sql
</span> =
<span class=
"var-default">""</span>])
858 <ul class=
"parameters">
860 <span class=
"var-type"></span>
861 <span class=
"var-name">$field
</span> </li>
863 <span class=
"var-type"></span>
864 <span class=
"var-name">$sql
</span> </li>
866 <span class=
"var-type"></span>
867 <span class=
"var-name">$lookup_sql
</span> </li>
872 <a name=
"methodAndWhere" id=
"AndWhere"><!-- --></a>
873 <div class=
"evenrow">
875 <div class=
"method-header">
876 <img src=
"../../media/images/Method.png" />
877 <span class=
"method-title">AndWhere
</span> (line
<span class=
"line-number">270</span>)
880 <!-- ========== Info from phpDoc block ========= -->
882 <div class=
"method-signature">
883 <span class=
"method-result">void
</span>
884 <span class=
"method-name">
887 (
<span class=
"var-type"></span> <span class=
"var-name">$more_where
</span>)
890 <ul class=
"parameters">
892 <span class=
"var-type"></span>
893 <span class=
"var-name">$more_where
</span> </li>
898 <a name=
"methodAssign" id=
"Assign"><!-- --></a>
901 <div class=
"method-header">
902 <img src=
"../../media/images/Method.png" />
903 <span class=
"method-title">Assign
</span> (line
<span class=
"line-number">189</span>)
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>
909 <div class=
"method-signature">
910 <span class=
"method-result">void
</span>
911 <span class=
"method-name">
914 (
<span class=
"var-type">string
</span> <span class=
"var-name">$value_field_name
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$new_value
</span>)
917 <ul class=
"parameters">
919 <span class=
"var-type">string
</span>
920 <span class=
"var-name">$value_field_name
</span> </li>
922 <span class=
"var-type">string
</span>
923 <span class=
"var-name">$new_value
</span> </li>
928 <a name=
"methodAvailable" id=
"Available"><!-- --></a>
929 <div class=
"evenrow">
931 <div class=
"method-header">
932 <img src=
"../../media/images/Method.png" />
933 <span class=
"method-title">Available
</span> (line
<span class=
"line-number">288</span>)
936 <!-- ========== Info from phpDoc block ========= -->
938 <div class=
"method-signature">
939 <span class=
"method-result">void
</span>
940 <span class=
"method-name">
949 <a name=
"methodGetRecord" id=
"GetRecord"><!-- --></a>
952 <div class=
"method-header">
953 <img src=
"../../media/images/Method.png" />
954 <span class=
"method-title">GetRecord
</span> (line
<span class=
"line-number">326</span>)
957 <!-- ========== Info from phpDoc block ========= -->
959 <div class=
"method-signature">
960 <span class=
"method-result">void
</span>
961 <span class=
"method-name">
964 ([
<span class=
"var-type"></span> <span class=
"var-name">$where
</span> =
<span class=
"var-default">""</span>])
967 <ul class=
"parameters">
969 <span class=
"var-type"></span>
970 <span class=
"var-name">$where
</span> </li>
975 <a name=
"methodId" id=
"Id"><!-- --></a>
976 <div class=
"evenrow">
978 <div class=
"method-header">
979 <img src=
"../../media/images/Method.png" />
980 <span class=
"method-title">Id
</span> (line
<span class=
"line-number">198</span>)
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>
986 <div class=
"method-signature">
987 <span class=
"method-result">void
</span>
988 <span class=
"method-name">
991 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$id
</span> =
<span class=
"var-default">null
</span>])
994 <ul class=
"parameters">
996 <span class=
"var-type">string
</span>
997 <span class=
"var-name">$id
</span> </li>
1002 <a name=
"methodInitialise" id=
"Initialise"><!-- --></a>
1003 <div class=
"oddrow">
1005 <div class=
"method-header">
1006 <img src=
"../../media/images/Method.png" />
1007 <span class=
"method-title">Initialise
</span> (line
<span class=
"line-number">303</span>)
1010 <!-- ========== Info from phpDoc block ========= -->
1011 <p class=
"short-description">Set some particular values to the ones from the array.
</p>
1013 <div class=
"method-signature">
1014 <span class=
"method-result">void
</span>
1015 <span class=
"method-name">
1018 (
<span class=
"var-type">array
</span> <span class=
"var-name">$values
</span>)
1021 <ul class=
"parameters">
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>
1029 <a name=
"methodIsCreate" id=
"IsCreate"><!-- --></a>
1030 <div class=
"evenrow">
1032 <div class=
"method-header">
1033 <img src=
"../../media/images/Method.png" />
1034 <span class=
"method-title">IsCreate
</span> (line
<span class=
"line-number">250</span>)
1037 <!-- ========== Info from phpDoc block ========= -->
1039 <div class=
"method-signature">
1040 <span class=
"method-result">void
</span>
1041 <span class=
"method-name">
1050 <a name=
"methodIsSubmit" id=
"IsSubmit"><!-- --></a>
1051 <div class=
"oddrow">
1053 <div class=
"method-header">
1054 <img src=
"../../media/images/Method.png" />
1055 <span class=
"method-title">IsSubmit
</span> (line
<span class=
"line-number">237</span>)
1058 <!-- ========== Info from phpDoc block ========= -->
1060 <div class=
"method-signature">
1061 <span class=
"method-result">void
</span>
1062 <span class=
"method-name">
1071 <a name=
"methodIsUpdate" id=
"IsUpdate"><!-- --></a>
1072 <div class=
"evenrow">
1074 <div class=
"method-header">
1075 <img src=
"../../media/images/Method.png" />
1076 <span class=
"method-title">IsUpdate
</span> (line
<span class=
"line-number">241</span>)
1079 <!-- ========== Info from phpDoc block ========= -->
1081 <div class=
"method-signature">
1082 <span class=
"method-result">void
</span>
1083 <span class=
"method-name">
1092 <a name=
"methodLayout" id=
"Layout"><!-- --></a>
1093 <div class=
"oddrow">
1095 <div class=
"method-header">
1096 <img src=
"../../media/images/Method.png" />
1097 <span class=
"method-title">Layout
</span> (line
<span class=
"line-number">282</span>)
1100 <!-- ========== Info from phpDoc block ========= -->
1102 <div class=
"method-signature">
1103 <span class=
"method-result">void
</span>
1104 <span class=
"method-name">
1107 (
<span class=
"var-type"></span> <span class=
"var-name">$template
</span>)
1110 <ul class=
"parameters">
1112 <span class=
"var-type"></span>
1113 <span class=
"var-name">$template
</span> </li>
1118 <a name=
"methodMoreWhere" id=
"MoreWhere"><!-- --></a>
1119 <div class=
"evenrow">
1121 <div class=
"method-header">
1122 <img src=
"../../media/images/Method.png" />
1123 <span class=
"method-title">MoreWhere
</span> (line
<span class=
"line-number">262</span>)
1126 <!-- ========== Info from phpDoc block ========= -->
1128 <div class=
"method-signature">
1129 <span class=
"method-result">void
</span>
1130 <span class=
"method-name">
1133 (
<span class=
"var-type"></span> <span class=
"var-name">$operator
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$more_where
</span>)
1136 <ul class=
"parameters">
1138 <span class=
"var-type"></span>
1139 <span class=
"var-name">$operator
</span> </li>
1141 <span class=
"var-type"></span>
1142 <span class=
"var-name">$more_where
</span> </li>
1147 <a name=
"methodOrWhere" id=
"OrWhere"><!-- --></a>
1148 <div class=
"oddrow">
1150 <div class=
"method-header">
1151 <img src=
"../../media/images/Method.png" />
1152 <span class=
"method-title">OrWhere
</span> (line
<span class=
"line-number">274</span>)
1155 <!-- ========== Info from phpDoc block ========= -->
1157 <div class=
"method-signature">
1158 <span class=
"method-result">void
</span>
1159 <span class=
"method-name">
1162 (
<span class=
"var-type"></span> <span class=
"var-name">$more_where
</span>)
1165 <ul class=
"parameters">
1167 <span class=
"var-type"></span>
1168 <span class=
"var-name">$more_where
</span> </li>
1173 <a name=
"methodPostToValues" id=
"PostToValues"><!-- --></a>
1174 <div class=
"evenrow">
1176 <div class=
"method-header">
1177 <img src=
"../../media/images/Method.png" />
1178 <span class=
"method-title">PostToValues
</span> (line
<span class=
"line-number">316</span>)
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>
1184 <div class=
"method-signature">
1185 <span class=
"method-result">void
</span>
1186 <span class=
"method-name">
1189 ([
<span class=
"var-type"></span> <span class=
"var-name">$prefix
</span> =
<span class=
"var-default">''
</span>])
1192 <ul class=
"parameters">
1194 <span class=
"var-type"></span>
1195 <span class=
"var-name">$prefix
</span> </li>
1200 <a name=
"methodRender" id=
"Render"><!-- --></a>
1201 <div class=
"oddrow">
1203 <div class=
"method-header">
1204 <img src=
"../../media/images/Method.png" />
1205 <span class=
"method-title">Render
</span> (line
<span class=
"line-number">472</span>)
1208 <!-- ========== Info from phpDoc block ========= -->
1209 <p class=
"short-description">Render the templated component. The heavy lifting is done by the callback...
</p>
1211 <div class=
"method-signature">
1212 <span class=
"method-result">void
</span>
1213 <span class=
"method-name">
1216 ([
<span class=
"var-type"></span> <span class=
"var-name">$title_tag
</span> =
<span class=
"var-default">null
</span>])
1219 <ul class=
"parameters">
1221 <span class=
"var-type"></span>
1222 <span class=
"var-name">$title_tag
</span> </li>
1227 <a name=
"methodReplaceEditorPart" id=
"ReplaceEditorPart"><!-- --></a>
1228 <div class=
"evenrow">
1230 <div class=
"method-header">
1231 <img src=
"../../media/images/Method.png" />
1232 <span class=
"method-title">ReplaceEditorPart
</span> (line
<span class=
"line-number">354</span>)
1235 <!-- ========== Info from phpDoc block ========= -->
1236 <p class=
"short-description">Replace parts into the form template.
</p>
1238 <li><span class=
"field">return:
</span> What we want to replace this match with.
</li>
1241 <div class=
"method-signature">
1242 <span class=
"method-result">string
</span>
1243 <span class=
"method-name">
1246 (
<span class=
"var-type">array
</span> <span class=
"var-name">$matches
</span>)
1249 <ul class=
"parameters">
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>
1257 <a name=
"methodSetBaseTable" id=
"SetBaseTable"><!-- --></a>
1258 <div class=
"oddrow">
1260 <div class=
"method-header">
1261 <img src=
"../../media/images/Method.png" />
1262 <span class=
"method-title">SetBaseTable
</span> (line
<span class=
"line-number">212</span>)
1265 <!-- ========== Info from phpDoc block ========= -->
1267 <div class=
"method-signature">
1268 <span class=
"method-result">void
</span>
1269 <span class=
"method-name">
1272 (
<span class=
"var-type"></span> <span class=
"var-name">$base_table
</span>)
1275 <ul class=
"parameters">
1277 <span class=
"var-type"></span>
1278 <span class=
"var-name">$base_table
</span> </li>
1283 <a name=
"methodSetJoins" id=
"SetJoins"><!-- --></a>
1284 <div class=
"evenrow">
1286 <div class=
"method-header">
1287 <img src=
"../../media/images/Method.png" />
1288 <span class=
"method-title">SetJoins
</span> (line
<span class=
"line-number">216</span>)
1291 <!-- ========== Info from phpDoc block ========= -->
1293 <div class=
"method-signature">
1294 <span class=
"method-result">void
</span>
1295 <span class=
"method-name">
1298 (
<span class=
"var-type"></span> <span class=
"var-name">$join_list
</span>)
1301 <ul class=
"parameters">
1303 <span class=
"var-type"></span>
1304 <span class=
"var-name">$join_list
</span> </li>
1309 <a name=
"methodSetLookup" id=
"SetLookup"><!-- --></a>
1310 <div class=
"oddrow">
1312 <div class=
"method-header">
1313 <img src=
"../../media/images/Method.png" />
1314 <span class=
"method-title">SetLookup
</span> (line
<span class=
"line-number">169</span>)
1317 <!-- ========== Info from phpDoc block ========= -->
1319 <div class=
"method-signature">
1320 <span class=
"method-result">void
</span>
1321 <span class=
"method-name">
1324 (
<span class=
"var-type"></span> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$lookup_sql
</span>)
1327 <ul class=
"parameters">
1329 <span class=
"var-type"></span>
1330 <span class=
"var-name">$field
</span> </li>
1332 <span class=
"var-type"></span>
1333 <span class=
"var-name">$lookup_sql
</span> </li>
1338 <a name=
"methodSetOptionList" id=
"SetOptionList"><!-- --></a>
1339 <div class=
"evenrow">
1341 <div class=
"method-header">
1342 <img src=
"../../media/images/Method.png" />
1343 <span class=
"method-title">SetOptionList
</span> (line
<span class=
"line-number">203</span>)
1346 <!-- ========== Info from phpDoc block ========= -->
1348 <div class=
"method-signature">
1349 <span class=
"method-result">void
</span>
1350 <span class=
"method-name">
1353 (
<span class=
"var-type"></span> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$options
</span>, [
<span class=
"var-type"></span> <span class=
"var-name">$current
</span> =
<span class=
"var-default">null
</span>], [
<span class=
"var-type"></span> <span class=
"var-name">$parameters
</span> =
<span class=
"var-default">null
</span>])
1356 <ul class=
"parameters">
1358 <span class=
"var-type"></span>
1359 <span class=
"var-name">$field
</span> </li>
1361 <span class=
"var-type"></span>
1362 <span class=
"var-name">$options
</span> </li>
1364 <span class=
"var-type"></span>
1365 <span class=
"var-name">$current
</span> </li>
1367 <span class=
"var-type"></span>
1368 <span class=
"var-name">$parameters
</span> </li>
1373 <a name=
"methodSetRecord" id=
"SetRecord"><!-- --></a>
1374 <div class=
"oddrow">
1376 <div class=
"method-header">
1377 <img src=
"../../media/images/Method.png" />
1378 <span class=
"method-title">SetRecord
</span> (line
<span class=
"line-number">292</span>)
1381 <!-- ========== Info from phpDoc block ========= -->
1383 <div class=
"method-signature">
1384 <span class=
"method-result">void
</span>
1385 <span class=
"method-name">
1388 (
<span class=
"var-type"></span> <span class=
"var-name">$row
</span>)
1391 <ul class=
"parameters">
1393 <span class=
"var-type"></span>
1394 <span class=
"var-name">$row
</span> </li>
1399 <a name=
"methodSetSql" id=
"SetSql"><!-- --></a>
1400 <div class=
"evenrow">
1402 <div class=
"method-header">
1403 <img src=
"../../media/images/Method.png" />
1404 <span class=
"method-title">SetSql
</span> (line
<span class=
"line-number">165</span>)
1407 <!-- ========== Info from phpDoc block ========= -->
1409 <div class=
"method-signature">
1410 <span class=
"method-result">void
</span>
1411 <span class=
"method-name">
1414 (
<span class=
"var-type"></span> <span class=
"var-name">$field
</span>,
<span class=
"var-type"></span> <span class=
"var-name">$sql
</span>)
1417 <ul class=
"parameters">
1419 <span class=
"var-type"></span>
1420 <span class=
"var-name">$field
</span> </li>
1422 <span class=
"var-type"></span>
1423 <span class=
"var-name">$sql
</span> </li>
1428 <a name=
"methodSetSubmitName" id=
"SetSubmitName"><!-- --></a>
1429 <div class=
"oddrow">
1431 <div class=
"method-header">
1432 <img src=
"../../media/images/Method.png" />
1433 <span class=
"method-title">SetSubmitName
</span> (line
<span class=
"line-number">233</span>)
1436 <!-- ========== Info from phpDoc block ========= -->
1438 <div class=
"method-signature">
1439 <span class=
"method-result">void
</span>
1440 <span class=
"method-name">
1443 (
<span class=
"var-type"></span> <span class=
"var-name">$new_submit
</span>)
1446 <ul class=
"parameters">
1448 <span class=
"var-type"></span>
1449 <span class=
"var-name">$new_submit
</span> </li>
1454 <a name=
"methodSetTemplate" id=
"SetTemplate"><!-- --></a>
1455 <div class=
"evenrow">
1457 <div class=
"method-header">
1458 <img src=
"../../media/images/Method.png" />
1459 <span class=
"method-title">SetTemplate
</span> (line
<span class=
"line-number">278</span>)
1462 <!-- ========== Info from phpDoc block ========= -->
1464 <div class=
"method-signature">
1465 <span class=
"method-result">void
</span>
1466 <span class=
"method-name">
1469 (
<span class=
"var-type"></span> <span class=
"var-name">$template
</span>)
1472 <ul class=
"parameters">
1474 <span class=
"var-type"></span>
1475 <span class=
"var-name">$template
</span> </li>
1480 <a name=
"methodSetWhere" id=
"SetWhere"><!-- --></a>
1481 <div class=
"oddrow">
1483 <div class=
"method-header">
1484 <img src=
"../../media/images/Method.png" />
1485 <span class=
"method-title">SetWhere
</span> (line
<span class=
"line-number">254</span>)
1488 <!-- ========== Info from phpDoc block ========= -->
1490 <div class=
"method-signature">
1491 <span class=
"method-result">void
</span>
1492 <span class=
"method-name">
1495 (
<span class=
"var-type"></span> <span class=
"var-name">$where_clause
</span>)
1498 <ul class=
"parameters">
1500 <span class=
"var-type"></span>
1501 <span class=
"var-name">$where_clause
</span> </li>
1506 <a name=
"methodTitle" id=
"Title"><!-- --></a>
1507 <div class=
"evenrow">
1509 <div class=
"method-header">
1510 <img src=
"../../media/images/Method.png" />
1511 <span class=
"method-title">Title
</span> (line
<span class=
"line-number">227</span>)
1514 <!-- ========== Info from phpDoc block ========= -->
1515 <p class=
"short-description">Accessor for the Title for the browse, which could set the title also.
</p>
1517 <li><span class=
"field">return:
</span> The current title for the browser
</li>
1520 <div class=
"method-signature">
1521 <span class=
"method-result">string
</span>
1522 <span class=
"method-name">
1525 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$new_title
</span> =
<span class=
"var-default">null
</span>])
1528 <ul class=
"parameters">
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>
1536 <a name=
"methodValue" id=
"Value"><!-- --></a>
1537 <div class=
"oddrow">
1539 <div class=
"method-header">
1540 <img src=
"../../media/images/Method.png" />
1541 <span class=
"method-title">Value
</span> (line
<span class=
"line-number">179</span>)
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>
1547 <div class=
"method-signature">
1548 <span class=
"method-result">void
</span>
1549 <span class=
"method-name">
1552 (
<span class=
"var-type">string
</span> <span class=
"var-name">$value_field_name
</span>)
1555 <ul class=
"parameters">
1557 <span class=
"var-type">string
</span>
1558 <span class=
"var-name">$value_field_name
</span> </li>
1563 <a name=
"methodWhereNewRecord" id=
"WhereNewRecord"><!-- --></a>
1564 <div class=
"evenrow">
1566 <div class=
"method-header">
1567 <img src=
"../../media/images/Method.png" />
1568 <span class=
"method-title">WhereNewRecord
</span> (line
<span class=
"line-number">258</span>)
1571 <!-- ========== Info from phpDoc block ========= -->
1573 <div class=
"method-signature">
1574 <span class=
"method-result">void
</span>
1575 <span class=
"method-name">
1578 (
<span class=
"var-type"></span> <span class=
"var-name">$where_clause
</span>)
1581 <ul class=
"parameters">
1583 <span class=
"var-type"></span>
1584 <span class=
"var-name">$where_clause
</span> </li>
1589 <a name=
"methodWrite" id=
"Write"><!-- --></a>
1590 <div class=
"oddrow">
1592 <div class=
"method-header">
1593 <img src=
"../../media/images/Method.png" />
1594 <span class=
"method-title">Write
</span> (line
<span class=
"line-number">495</span>)
1597 <!-- ========== Info from phpDoc block ========= -->
1598 <p class=
"short-description">Write the record
</p>
1600 <div class=
"method-signature">
1601 <span class=
"method-result">void
</span>
1602 <span class=
"method-name">
1605 ([
<span class=
"var-type">boolean
</span> <span class=
"var-name">$is_update
</span> =
<span class=
"var-default">null
</span>])
1608 <ul class=
"parameters">
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>
1621 <p class=
"notes" id=
"credit">
1622 Documentation generated on Sun,
17 Jun
2012 10:
00:
15 +
0000 by
<a href=
"http://www.phpdoc.org" target=
"_blank">phpDocumentor
1.4.3</a>