some more minimal doc formatting
[openemr.git] / gacl / adodb / rsfilter.inc.php
blob331300448f00a8b42fa1fdbd1a03f0f289b874f2
1 <?php
2 /**
3 * @version V4.92a 29 Aug 2006 (c) 2000-2006 John Lim (jlim#natsoft.com.my). All rights reserved.
4 * Released under both BSD license and Lesser GPL library license.
5 * Whenever there is any discrepancy between the two licenses,
6 * the BSD license will take precedence.
8 * Set tabs to 4 for best viewing.
9 *
10 * Latest version is available at http://php.weblogs.com
12 * Requires PHP4.01pl2 or later because it uses include_once
16 Filter all fields and all rows in a recordset and returns the
17 processed recordset. We scroll to the beginning of the new recordset
18 after processing.
20 We pass a recordset and function name to RSFilter($rs,'rowfunc');
21 and the function will be called multiple times, once
22 for each row in the recordset. The function will be passed
23 an array containing one row repeatedly.
25 Example:
27 // ucwords() every element in the recordset
28 function do_ucwords(&$arr,$rs)
30 foreach($arr as $k => $v) {
31 $arr[$k] = ucwords($v);
34 $rs = RSFilter($rs,'do_ucwords');
36 function &RSFilter($rs,$fn)
38 if ($rs->databaseType != 'array') {
39 if (!$rs->connection) return false;
41 $rs = &$rs->connection->_rs2rs($rs);
43 $rows = $rs->RecordCount();
44 for ($i=0; $i < $rows; $i++) {
45 if (is_array ($fn)) {
46 $obj = $fn[0];
47 $method = $fn[1];
48 $obj->$method ($rs->_array[$i],$rs);
49 } else {
50 $fn($rs->_array[$i],$rs);
54 if (!$rs->EOF) {
55 $rs->_currentRow = 0;
56 $rs->fields = $rs->_array[0];
59 return $rs;