| blob | b7180abb46ff549925fcdddb5da876c2c1e0dcce |
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
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){
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':
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 }
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':
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 }
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':
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 }
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
101 </div>
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">Start a new Browser, add columns, set a join and Render it to create a basic list of records in a table.</p>
105 <p class="description"><p>You can, of course, get a lot fancier with setting ordering, where clauses totalled columns and so forth.</p></p>
107 Located in <a class="field" href="_classBrowser.php.html">/classBrowser.php</a> (line <span class="field">174</span>)
108 </p>
111 <pre></pre>
113 </div>
114 </div>
124 |
127 </div>
134 </div>
139 </div>
144 </div>
149 </div>
154 </div>
159 </div>
164 </div>
169 </div>
174 </div>
179 </div>
184 </div>
189 </div>
194 </div>
199 </div>
204 </div>
209 </div>
214 </div>
219 </div>
224 </div>
229 </div>
234 </div>
239 </div>
244 </div>
249 </div>
254 </div>
259 </div>
264 </div>
269 </div>
274 </div>
275 </div>
276 </div>
277 </div>
286 |
288 </div>
296 ([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">""</span>])
297 </div>
303 (<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">string</span> <span class="var-name">$header</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$format</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">""</span>], [<span class="var-type"></span> <span class="var-name">$datatype</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$hook</span> = <span class="var-default">null</span>])
304 </div>
310 (<span class="var-type"></span> <span class="var-name">$field</span>, [<span class="var-type"></span> <span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>])
311 </div>
317 (<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">""</span>])
318 </div>
324 (<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$direction</span>, [<span class="var-type">string</span> <span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$secondary</span> = <span class="var-default">0</span>])
325 </div>
332 </div>
338 (<span class="var-type">string</span> <span class="var-name">$column_name</span>, [<span class="var-type">string</span> <span class="var-name">$total_function</span> = <span class="var-default">false</span>])
339 </div>
346 </div>
352 ()
353 </div>
359 (<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$direction</span>)
360 </div>
367 </div>
373 (<span class="var-type">string</span> <span class="var-name">$column</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, <span class="var-type">string</span> <span class="var-name">$function</span>)
374 </div>
380 (<span class="var-type">string</span> <span class="var-name">$operator</span>, <span class="var-type">string</span> <span class="var-name">$more_where</span>)
381 </div>
388 </div>
394 ([<span class="var-type">string</span> <span class="var-name">$title_tag</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$subtitle_tag</span> = <span class="var-default">null</span>])
395 </div>
401 (<span class="var-type">string</span> <span class="var-name">$beginrow</span>, <span class="var-type">string</span> <span class="var-name">$closerow</span>, <span class="var-type">string</span> <span class="var-name">$rowargs</span>)
402 </div>
409 </div>
415 (<span class="var-type">string</span> <span class="var-name">$open_div</span>, <span class="var-type">string</span> <span class="var-name">$close_div</span>)
416 </div>
423 </div>
430 </div>
437 </div>
443 ([<span class="var-type"></span> <span class="var-name">$default_fld</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$default_dir</span> = <span class="var-default">'A'</span>], [<span class="var-type"></span> <span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>])
444 </div>
451 </div>
458 </div>
465 </div>
472 </div>
479 </div>
485 ([<span class="var-type">string</span> <span class="var-name">$new_title</span> = <span class="var-default">null</span>])
486 </div>
493 </div>
494 </div>
495 </div>
496 </div>
506 |
509 </div>
521 </span>
522 </div>
524 <!-- ========== Info from phpDoc block ========= -->
530 </div>
540 </span>
541 </div>
543 <!-- ========== Info from phpDoc block ========= -->
549 </div>
559 </span>
560 </div>
562 <!-- ========== Info from phpDoc block ========= -->
568 </div>
578 </span>
579 </div>
581 <!-- ========== Info from phpDoc block ========= -->
587 </div>
597 </span>
598 </div>
600 <!-- ========== Info from phpDoc block ========= -->
606 </div>
616 </span>
617 </div>
619 <!-- ========== Info from phpDoc block ========= -->
625 </div>
635 </span>
636 </div>
638 <!-- ========== Info from phpDoc block ========= -->
644 </div>
654 </span>
655 </div>
657 <!-- ========== Info from phpDoc block ========= -->
663 </div>
673 </span>
674 </div>
676 <!-- ========== Info from phpDoc block ========= -->
682 </div>
692 </span>
693 </div>
695 <!-- ========== Info from phpDoc block ========= -->
701 </div>
711 </span>
712 </div>
714 <!-- ========== Info from phpDoc block ========= -->
720 </div>
730 </span>
731 </div>
733 <!-- ========== Info from phpDoc block ========= -->
739 </div>
749 </span>
750 </div>
752 <!-- ========== Info from phpDoc block ========= -->
758 </div>
768 </span>
769 </div>
771 <!-- ========== Info from phpDoc block ========= -->
777 </div>
787 </span>
788 </div>
790 <!-- ========== Info from phpDoc block ========= -->
796 </div>
806 </span>
807 </div>
809 <!-- ========== Info from phpDoc block ========= -->
815 </div>
825 </span>
826 </div>
828 <!-- ========== Info from phpDoc block ========= -->
834 </div>
844 </span>
845 </div>
847 <!-- ========== Info from phpDoc block ========= -->
853 </div>
863 </span>
864 </div>
866 <!-- ========== Info from phpDoc block ========= -->
872 </div>
882 </span>
883 </div>
885 <!-- ========== Info from phpDoc block ========= -->
891 </div>
901 </span>
902 </div>
904 <!-- ========== Info from phpDoc block ========= -->
910 </div>
920 </span>
921 </div>
923 <!-- ========== Info from phpDoc block ========= -->
929 </div>
939 </span>
940 </div>
942 <!-- ========== Info from phpDoc block ========= -->
948 </div>
958 </span>
959 </div>
961 <!-- ========== Info from phpDoc block ========= -->
967 </div>
977 </span>
978 </div>
980 <!-- ========== Info from phpDoc block ========= -->
986 </div>
996 </span>
997 </div>
999 <!-- ========== Info from phpDoc block ========= -->
1005 </div>
1015 </span>
1016 </div>
1018 <!-- ========== Info from phpDoc block ========= -->
1024 </div>
1034 </span>
1035 </div>
1037 <!-- ========== Info from phpDoc block ========= -->
1043 </div>
1053 </span>
1054 </div>
1056 <!-- ========== Info from phpDoc block ========= -->
1062 </div>
1064 </div>
1065 </div>
1075 </div>
1083 <span class="method-title">Constructor Browser</span> (line <span class="line-number">211</span>)
1084 </div>
1086 <!-- ========== Info from phpDoc block ========= -->
1092 Browser
1093 </span>
1094 ([<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">""</span>])
1095 </div>
1098 <li>
1100 <span class="var-name">$title</span><span class="var-description">: A title for the browser (optional).</span> </li>
1101 </ul>
1104 </div>
1111 </div>
1113 <!-- ========== Info from phpDoc block ========= -->
1115 <p class="description"><p>This constructs a new BrowserColumn, appending it to the array of columns in this Browser.</p><p>Note that if the $format parameter starts with '<td>' the format will replace the column format, otherwise it will be used within '<td>...</td>' tags.</p></p>
1117 <li><span class="field">see:</span> <a href="../../awl/Browser/BrowserColumn.html">BrowserColumn</a></li>
1118 </ul>
1123 AddColumn
1124 </span>
1125 (<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">string</span> <span class="var-name">$header</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$format</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">""</span>], [<span class="var-type"></span> <span class="var-name">$datatype</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$hook</span> = <span class="var-default">null</span>])
1126 </div>
1129 <li>
1131 <span class="var-name">$field</span><span class="var-description">: The name of the field.</span> </li>
1132 <li>
1134 <span class="var-name">$header</span><span class="var-description">: A column header for the field.</span> </li>
1135 <li>
1137 <span class="var-name">$align</span><span class="var-description">: An alignment for column values.</span> </li>
1138 <li>
1140 <span class="var-name">$format</span><span class="var-description">: A sprintf format for displaying column values.</span> </li>
1141 <li>
1143 <span class="var-name">$sql</span><span class="var-description">: An SQL fragment for calculating the value.</span> </li>
1144 <li>
1146 <span class="var-name">$class</span><span class="var-description">: A CSS class to apply to the cells of this column.</span> </li>
1147 <li>
1149 <span class="var-name">$hook</span><span class="var-description">: <p>The name of a global function which will preprocess the column value</p><p>The hook function should be defined as follows: function hookfunction( $column_value, $column_name, $database_row ) { ... return $value; }</p></span> </li>
1150 <li>
1153 </ul>
1156 </div>
1163 </div>
1165 <!-- ========== Info from phpDoc block ========= -->
1170 AddGrouping
1171 </span>
1172 (<span class="var-type"></span> <span class="var-name">$field</span>, [<span class="var-type"></span> <span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>])
1173 </div>
1176 <li>
1179 <li>
1182 </ul>
1185 </div>
1192 </div>
1194 <!-- ========== Info from phpDoc block ========= -->
1195 <p class="short-description">Add a hidden column - one that is present in the SQL result, but for which there is no column displayed.</p>
1196 <p class="description"><p>This can be useful for including a value in (e.g.) clickable links or title attributes which is not actually displayed as a visible column.</p></p>
1201 AddHidden
1202 </span>
1203 (<span class="var-type">string</span> <span class="var-name">$field</span>, [<span class="var-type">string</span> <span class="var-name">$sql</span> = <span class="var-default">""</span>])
1204 </div>
1207 <li>
1209 <span class="var-name">$field</span><span class="var-description">: The name of the field.</span> </li>
1210 <li>
1212 <span class="var-name">$sql</span><span class="var-description">: An SQL fragment to calculate the field, if it is calculated.</span> </li>
1213 </ul>
1216 </div>
1223 </div>
1225 <!-- ========== Info from phpDoc block ========= -->
1227 <p class="description"><p>The ordering can be overridden by GET parameters which will be rendered into the column headers so that a user can click on the column headers to control the actual order.</p></p>
1232 AddOrder
1233 </span>
1234 (<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$direction</span>, [<span class="var-type">string</span> <span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$secondary</span> = <span class="var-default">0</span>])
1235 </div>
1238 <li>
1240 <span class="var-name">$field</span><span class="var-description">: The name of the field to be ordered by.</span> </li>
1241 <li>
1243 <span class="var-name">$direction</span><span class="var-description">: A for Ascending, otherwise it will be descending order.</span> </li>
1244 <li>
1246 <span class="var-name">$browser_array_key</span><span class="var-description">: Use this to distinguish between multiple browser widgets on the same page. Leave it empty if you only have a single browser instance.</span> </li>
1247 <li>
1249 <span class="var-name">$secondary</span><span class="var-description">: Use this to indicate a default secondary order which shouldn't interfere with the default primary order.</span> </li>
1250 </ul>
1253 </div>
1260 </div>
1262 <!-- ========== Info from phpDoc block ========= -->
1265 <li><span class="field">var:</span> Contains an array of named fields, hopefully matching the column names.</li>
1266 </ul>
1271 AddRow
1272 </span>
1274 </div>
1277 <li>
1280 </ul>
1283 </div>
1290 </div>
1292 <!-- ========== Info from phpDoc block ========= -->
1293 <p class="short-description">Mark a column as something to be totalled. You can also specify the name of a function which may modify the value before the actual totalling.</p>
1294 <p class="description"><p>The callback function will be called with each row, with the first argument being the entire record object and the second argument being only the column being totalled. The callback should return a number, to be added to the total.</p></p>
1299 AddTotal
1300 </span>
1301 (<span class="var-type">string</span> <span class="var-name">$column_name</span>, [<span class="var-type">string</span> <span class="var-name">$total_function</span> = <span class="var-default">false</span>])
1302 </div>
1305 <li>
1307 <span class="var-name">$column_name</span><span class="var-description">: The name of the column to be totalled.</span> </li>
1308 <li>
1310 <span class="var-name">$total_function</span><span class="var-description">: The name of the callback function.</span> </li>
1311 </ul>
1314 </div>
1321 </div>
1323 <!-- ========== Info from phpDoc block ========= -->
1329 AndWhere
1330 </span>
1332 </div>
1335 <li>
1337 <span class="var-name">$more_where</span><span class="var-description">: The extra part of the where clause</span> </li>
1338 </ul>
1341 </div>
1348 </div>
1350 <!-- ========== Info from phpDoc block ========= -->
1352 <p class="description"><p>You need not call this method, since Browser::Render() will call it for you if you have not done so at that point.</p></p>
1355 </ul>
1360 DoQuery
1361 </span>
1362 ()
1363 </div>
1367 </div>
1374 </div>
1376 <!-- ========== Info from phpDoc block ========= -->
1382 ForceOrder
1383 </span>
1384 (<span class="var-type">string</span> <span class="var-name">$field</span>, <span class="var-type">string</span> <span class="var-name">$direction</span>)
1385 </div>
1388 <li>
1390 <span class="var-name">$field</span><span class="var-description">: The name of the field to be ordered by.</span> </li>
1391 <li>
1393 <span class="var-name">$direction</span><span class="var-description">: A for Ascending, otherwise it will be descending order.</span> </li>
1394 </ul>
1397 </div>
1404 </div>
1406 <!-- ========== Info from phpDoc block ========= -->
1412 GetTotal
1413 </span>
1415 </div>
1418 <li>
1420 <span class="var-name">$column_name</span><span class="var-description">: The name of the column to be totalled.</span> </li>
1421 </ul>
1424 </div>
1431 </div>
1433 <!-- ========== Info from phpDoc block ========= -->
1434 <p class="short-description">Replace a row where $column = $value with an extra arbitrary row, returned from calling $function</p>
1439 MatchedRow
1440 </span>
1441 (<span class="var-type">string</span> <span class="var-name">$column</span>, <span class="var-type">string</span> <span class="var-name">$value</span>, <span class="var-type">string</span> <span class="var-name">$function</span>)
1442 </div>
1445 <li>
1447 <span class="var-name">$column</span><span class="var-description">: The name of a column to match</span> </li>
1448 <li>
1450 <span class="var-name">$value</span><span class="var-description">: The value to match in the column</span> </li>
1451 <li>
1453 <span class="var-name">$function</span><span class="var-description">: The name of the function to call for the matched row</span> </li>
1454 </ul>
1457 </div>
1464 </div>
1466 <!-- ========== Info from phpDoc block ========= -->
1468 <p class="description"><p>You will generally want to call OrWhere or AndWhere rather than this function, but hey: who am I to tell you how to code!</p></p>
1473 MoreWhere
1474 </span>
1475 (<span class="var-type">string</span> <span class="var-name">$operator</span>, <span class="var-type">string</span> <span class="var-name">$more_where</span>)
1476 </div>
1479 <li>
1481 <span class="var-name">$operator</span><span class="var-description">: The operator to combine with previous where clause parts.</span> </li>
1482 <li>
1484 <span class="var-name">$more_where</span><span class="var-description">: The extra part of the where clause</span> </li>
1485 </ul>
1488 </div>
1495 </div>
1497 <!-- ========== Info from phpDoc block ========= -->
1503 OrWhere
1504 </span>
1506 </div>
1509 <li>
1511 <span class="var-name">$more_where</span><span class="var-description">: The extra part of the where clause</span> </li>
1512 </ul>
1515 </div>
1522 </div>
1524 <!-- ========== Info from phpDoc block ========= -->
1525 <p class="short-description">This method is used to render the browser as HTML. If the query has not yet been executed then this will call DoQuery to do so.</p>
1526 <p class="description"><p>The browser (including the title) will be displayed in a div with id="browser" so that you can style '#browser tr.header', '#browser tr.totals' and so forth.</p></p>
1529 </ul>
1534 Render
1535 </span>
1536 ([<span class="var-type">string</span> <span class="var-name">$title_tag</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$subtitle_tag</span> = <span class="var-default">null</span>])
1537 </div>
1540 <li>
1542 <span class="var-name">$title_tag</span><span class="var-description">: The tag to use around the browser title (default 'h1')</span> </li>
1543 <li>
1546 </ul>
1549 </div>
1556 </div>
1558 <!-- ========== Info from phpDoc block ========= -->
1560 <p class="description"><p>The row format is set as an sprintf format string for the start of the row, and a plain text string for the close of the row. Subsequent arguments are interpreted as names of fields, the values of which will be sprintf'd into the beginrow string for each row.</p><p>Some special field names exist beginning with the '#' character which have 'magic' functionality, including '#even' which will insert '0' for even rows and '1' for odd rows, allowing a nice colour alternation if the beginrow format refers to it like: 'class="r%d"' so that even rows will become 'class="r0"' and odd rows will be 'class="r1"'.</p><p>At present only '#even' exists, although other magic values may be defined in future.</p></p>
1565 RowFormat
1566 </span>
1567 (<span class="var-type">string</span> <span class="var-name">$beginrow</span>, <span class="var-type">string</span> <span class="var-name">$closerow</span>, <span class="var-type">string</span> <span class="var-name">$rowargs</span>)
1568 </div>
1571 <li>
1573 <span class="var-name">$beginrow</span><span class="var-description">: The new printf format for the start of the row.</span> </li>
1574 <li>
1576 <span class="var-name">$closerow</span><span class="var-description">: The new string for the close of the row.</span> </li>
1577 <li>
1579 <span class="var-name">$rowargs</span><span class="var-description">: ... The row arguments which will be sprintf'd into the $beginrow format for each row</span> </li>
1580 </ul>
1583 </div>
1590 </div>
1592 <!-- ========== Info from phpDoc block ========= -->
1599 SetDistinct
1600 </span>
1602 </div>
1605 <li>
1607 <span class="var-name">$distinct</span><span class="var-description">: The whole clause, after 'DISTINCT'</span> </li>
1608 </ul>
1611 </div>
1618 </div>
1620 <!-- ========== Info from phpDoc block ========= -->
1626 SetDiv
1627 </span>
1628 (<span class="var-type">string</span> <span class="var-name">$open_div</span>, <span class="var-type">string</span> <span class="var-name">$close_div</span>)
1629 </div>
1632 <li>
1634 <span class="var-name">$open_div</span><span class="var-description">: The HTML to open the div</span> </li>
1635 <li>
1637 <span class="var-name">$close_div</span><span class="var-description">: The HTML to open the div</span> </li>
1638 </ul>
1641 </div>
1648 </div>
1650 <!-- ========== Info from phpDoc block ========= -->
1652 <p class="description"><p>For a single table this should just contain the name of that table, but for multiple tables it should be the full content of the SQL 'FROM ...' clause (excluding the actual 'FROM' keyword).</p></p>
1657 SetJoins
1658 </span>
1660 </div>
1663 <li>
1666 </ul>
1669 </div>
1676 </div>
1678 <!-- ========== Info from phpDoc block ========= -->
1685 SetLimit
1686 </span>
1688 </div>
1691 <li>
1693 <span class="var-name">$limit_n</span><span class="var-description">: A number of rows to limit the SQL selection to</span> </li>
1694 </ul>
1697 </div>
1704 </div>
1706 <!-- ========== Info from phpDoc block ========= -->
1713 SetOffset
1714 </span>
1716 </div>
1719 <li>
1721 <span class="var-name">$offset_n</span><span class="var-description">: A number of rows to offset the SQL selection to, based from the start of the results.</span> </li>
1722 </ul>
1725 </div>
1732 </div>
1734 <!-- ========== Info from phpDoc block ========= -->
1735 <p class="short-description">Set up the ordering for the browser. Generally you should call this with the first parameter set as a field to order by default. Call with the second parameter set to 'D' or 'DESCEND' if you want to reverse the default order.</p>
1740 SetOrdering
1741 </span>
1742 ([<span class="var-type"></span> <span class="var-name">$default_fld</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$default_dir</span> = <span class="var-default">'A'</span>], [<span class="var-type"></span> <span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>])
1743 </div>
1746 <li>
1749 <li>
1752 <li>
1755 </ul>
1758 </div>
1765 </div>
1767 <!-- ========== Info from phpDoc block ========= -->
1773 SetSubTitle
1774 </span>
1776 </div>
1779 <li>
1781 <span class="var-name">$sub_title</span><span class="var-description">: The sub title string</span> </li>
1782 </ul>
1785 </div>
1792 </div>
1794 <!-- ========== Info from phpDoc block ========= -->
1796 <p class="description"><p>This can also be set in the constructor but if you create a template Browser and then clone it in a loop you may want to assign a different Title for each instance.</p></p>
1801 SetTitle
1802 </span>
1804 </div>
1807 <li>
1809 <span class="var-name">$new_title</span><span class="var-description">: The new title for the browser</span> </li>
1810 </ul>
1813 </div>
1820 </div>
1822 <!-- ========== Info from phpDoc block ========= -->
1828 SetTranslatable
1829 </span>
1831 </div>
1834 <li>
1836 <span class="var-name">$column_list</span><span class="var-description">: The list of columns which are translatable</span> </li>
1837 </ul>
1840 </div>
1847 </div>
1849 <!-- ========== Info from phpDoc block ========= -->
1851 <p class="description"><p>In rare cases this might be useful. It's currently a fairly simple hack which requires you to put an entire valid (& matching) UNION subclause (although without the UNION keyword).</p></p>
1856 SetUnion
1857 </span>
1859 </div>
1862 <li>
1865 </ul>
1868 </div>
1875 </div>
1877 <!-- ========== Info from phpDoc block ========= -->
1884 SetWhere
1885 </span>
1887 </div>
1890 <li>
1892 <span class="var-name">$where_clause</span><span class="var-description">: A valide SQL WHERE ... clause.</span> </li>
1893 </ul>
1896 </div>
1903 </div>
1905 <!-- ========== Info from phpDoc block ========= -->
1906 <p class="short-description">Accessor for the Title for the browse, which could set the title also.</p>
1909 </ul>
1914 Title
1915 </span>
1916 ([<span class="var-type">string</span> <span class="var-name">$new_title</span> = <span class="var-default">null</span>])
1917 </div>
1920 <li>
1922 <span class="var-name">$new_title</span><span class="var-description">: The new title for the browser</span> </li>
1923 </ul>
1926 </div>
1933 </div>
1935 <!-- ========== Info from phpDoc block ========= -->
1936 <p class="short-description">Return values from the current row for replacing into a template.</p>
1937 <p class="description"><p>This is used to return values from the current row, so they can be inserted into a row template. It is used as a callback function for preg_replace_callback.</p></p>
1942 ValueReplacement
1943 </span>
1945 </div>
1948 <li>
1950 <span class="var-name">$matches</span><span class="var-description">: of string $matches An array containing a field name as offset 1</span> </li>
1951 </ul>
1954 </div>
1956 </div>
1957 </div>
1961 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>
1962 </p>
1963 </div></body>
1964 </html>