Differences

This shows you the differences between two versions of the page.

--- reference:fetchobj [2015/07/27 04:46] – created mnewnham
+++ v5:reference:recordset:fetchobj [2023/06/11 12:25] (current) – dregad
@@ Line 1: / Line 1: @@
 ====== fetchObj =======
+~~NOTOC~~
 <WRAP right box>
-  obj fetchObj(
+  obj fetchObj()
-      optional bool $upperCaseKeys=false
+  obj fetchObject(
+      optional bool $upperCaseKeys=true
       )
 </WRAP>
+====== fetchObject =======
 ===== Description =====
+The ''fetchObj()'' / ''fetchObject()'' functions return the current row of a RecordSet as an ADOFetchObj object.
+They can be considered as aliases, except for the fact that ''fetchObject()'' converts the field names to uppercase by default, whereas ''fetchObj()'' does not.
+Unlike the [[v5:reference:recordset:fetchNextObj()]] method, the record pointer is not advanced. It is recommended that the 2 methods are not mixed in the same procedure.
+If the SQL statement results in an empty recordset or if the recordset has moved past end of file, then calling fetchObj() will return an empty record. Use [[v5:reference:connection:recordcount|recordCount()]] or check the EOF flag to ensure that you have retrieved a record.
+Results are influenced both by the [[v5:reference:adodb_assoc_case|ADODB_ASSOC_CASE]] constant and [[v5:reference:adodb_fetch_mode|$ADODB_FETCH_MODE]] attribute.
+The ADOFetchObj object has no special functionality, but the method is useful when the recordset data needs to be converted into e.g. JSON.
+-------------------
+===== Usage =====
+<code php>
+/*
+ * Database connection assumed
+ */
+$SQL = "SELECT * FROM Employees"
+$result = $db->execute($SQL);
+$r = $result->fetchObj()
+   print_r($r);
+/*
+ * returns
+ADOFetchObj Object
+(
+    [emp_no] => 10001
+    [birth_date] => 1953-09-02
+    [first_name] => Georgi
+    [last_name] => Facello
+    [gender] => M
+    [hire_date] => 1986-06-26
+)
+*/
+print $r->first_name;
+/*
+* prints 'Georgi';
+*/
+</code>
+{{tag>[PEAR Objects]}}