<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Returns the next row from a query as an object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.oci-fetch-assoc.html">oci_fetch_assoc</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.oci-fetch-row.html">oci_fetch_row</a></div> <div class="up"><a href="ref.oci8.html">OCI8 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.oci-fetch-object" class="refentry"> <div class="refnamediv"> <h1 class="refname">oci_fetch_object</h1> <p class="verinfo">(PHP 5, PECL OCI8 >= 1.1.0)</p><p class="refpurpose"><span class="refname">oci_fetch_object</span> — <span class="dc-title">Returns the next row from a query as an object</span></p> </div> <div class="refsect1 description" id="refsect1-function.oci-fetch-object-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><strong>oci_fetch_object</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$statement</code></span> )</div> <p class="para rdfs-comment"> Returns an object containing the next result-set row of a query. Each attribute of the object corresponds to a column of the row. This function is typically called in a loop until it returns <strong><code>FALSE</code></strong>, indicating no more rows exist. </p> <p class="para">For details on the data type mapping performed by the OCI8 extension, see the <a href="oci8.datatypes.html" class="link">datatypes supported by the driver</a></p> </div> <div class="refsect1 parameters" id="refsect1-function.oci-fetch-object-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">statement</code></em></span> <dd> <p class="para">A valid OCI8 statement identifier created by <span class="function"><a href="function.oci-parse.html" class="function">oci_parse()</a></span> and executed by <span class="function"><a href="function.oci-execute.html" class="function">oci_execute()</a></span>, or a <em>REF CURSOR</em> statement identifier.</p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.oci-fetch-object-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an object. Each attribute of the object corresponds to a column of the row. If there are no more rows in the <em><code class="parameter">statement</code></em> then <strong><code>FALSE</code></strong> is returned. </p> <p class="para"> Any <em>LOB</em> columns are returned as LOB descriptors. </p> <p class="para"> <em>DATE</em> columns are returned as strings formatted to the current date format. The default format can be changed with Oracle environment variables such as <em>NLS_LANG</em> or by a previously executed <em>ALTER SESSION SET NLS_DATE_FORMAT</em> command. </p> <p class="para"> Oracle's default, non-case sensitive column names will have uppercase attribute names. Case-sensitive column names will have attribute names using the exact column case. Use <span class="function"><a href="function.var-dump.html" class="function">var_dump()</a></span> on the result object to verify the appropriate case for attribute access. </p> <p class="para"> Attribute values will be <strong><code>NULL</code></strong> for any <em>NULL</em> data fields. </p> </div> <div class="refsect1 examples" id="refsect1-function.oci-fetch-object-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-1993"> <p><strong>Example #1 <span class="function"><strong>oci_fetch_object()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/*<br /> Before running, create the table:<br /> CREATE TABLE mytab (id NUMBER, description VARCHAR2(30));<br /> INSERT INTO mytab (id, description) values (1, 'Fish and Chips');<br /> COMMIT;<br />*/<br /><br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'hr'</span><span style="color: #007700">, </span><span style="color: #DD0000">'welcome'</span><span style="color: #007700">, </span><span style="color: #DD0000">'localhost/XE'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$e </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_error</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$e</span><span style="color: #007700">[</span><span style="color: #DD0000">'message'</span><span style="color: #007700">], </span><span style="color: #0000BB">ENT_QUOTES</span><span style="color: #007700">), </span><span style="color: #0000BB">E_USER_ERROR</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$stid </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'SELECT id, description FROM mytab'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">);<br /><br />while ((</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">)) != </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Use upper case attribute names for each standard Oracle column<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">ID </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br>\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">DESCRIPTION </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br>\n"</span><span style="color: #007700">; <br />}<br /><br /></span><span style="color: #FF8000">// Output is:<br />// 1<br />// Fish and Chips<br /><br /></span><span style="color: #0000BB">oci_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> <p class="para"> <div class="example" id="example-1994"> <p><strong>Example #2 <span class="function"><strong>oci_fetch_object()</strong></span> with case sensitive column names</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/*<br /> Before running, create the table with a case sensitive column name:<br /> CREATE TABLE mytab (id NUMBER, "MyDescription" VARCHAR2(30));<br /> INSERT INTO mytab (id, "MyDescription") values (1, 'Iced Coffee');<br /> COMMIT;<br />*/<br /><br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'hr'</span><span style="color: #007700">, </span><span style="color: #DD0000">'welcome'</span><span style="color: #007700">, </span><span style="color: #DD0000">'localhost/XE'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$e </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_error</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$e</span><span style="color: #007700">[</span><span style="color: #DD0000">'message'</span><span style="color: #007700">], </span><span style="color: #0000BB">ENT_QUOTES</span><span style="color: #007700">), </span><span style="color: #0000BB">E_USER_ERROR</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$stid </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'SELECT id, "MyDescription" FROM mytab'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">);<br /><br />while ((</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">)) != </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Use upper case attribute names for each standard Oracle column<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">ID </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br>\n"</span><span style="color: #007700">;<br /> </span><span style="color: #FF8000">// Use the exact case for the case sensitive column name<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">MyDescription </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br>\n"</span><span style="color: #007700">; <br />}<br /><br /></span><span style="color: #FF8000">// Output is:<br />// 1<br />// Iced Coffee<br /><br /></span><span style="color: #0000BB">oci_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> <p class="para"> <div class="example" id="example-1995"> <p><strong>Example #3 <span class="function"><strong>oci_fetch_object()</strong></span> with LOBs</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/*<br /> Before running, create the table:<br /> CREATE TABLE mytab (id NUMBER, description CLOB);<br /> INSERT INTO mytab (id, description) values (1, 'A very long string');<br /> COMMIT;<br />*/<br /><br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'hr'</span><span style="color: #007700">, </span><span style="color: #DD0000">'welcome'</span><span style="color: #007700">, </span><span style="color: #DD0000">'localhost/XE'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$e </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_error</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(</span><span style="color: #0000BB">$e</span><span style="color: #007700">[</span><span style="color: #DD0000">'message'</span><span style="color: #007700">], </span><span style="color: #0000BB">ENT_QUOTES</span><span style="color: #007700">), </span><span style="color: #0000BB">E_USER_ERROR</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$stid </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'SELECT id, description FROM mytab'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">);<br /><br />while ((</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">)) != </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">ID </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br>\n"</span><span style="color: #007700">;<br /> </span><span style="color: #FF8000">// The following will output the first 11 bytes from DESCRIPTION<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">DESCRIPTION</span><span style="color: #007700">-></span><span style="color: #0000BB">read</span><span style="color: #007700">(</span><span style="color: #0000BB">11</span><span style="color: #007700">) . </span><span style="color: #DD0000">"<br>\n"</span><span style="color: #007700">; <br />}<br /><br /></span><span style="color: #FF8000">// Output is:<br />// 1<br />// A very long<br /><br /></span><span style="color: #0000BB">oci_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stid</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.oci-fetch-object-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.oci-fetch.html" class="function" rel="rdfs-seeAlso">oci_fetch()</a> - Fetches the next row from a query into internal buffers</span></li> <li class="member"> <span class="function"><a href="function.oci-fetch-all.html" class="function" rel="rdfs-seeAlso">oci_fetch_all()</a> - Fetches multiple rows from a query into a two-dimensional array</span></li> <li class="member"> <span class="function"><a href="function.oci-fetch-assoc.html" class="function" rel="rdfs-seeAlso">oci_fetch_assoc()</a> - Returns the next row from a query as an associative array</span></li> <li class="member"> <span class="function"><a href="function.oci-fetch-array.html" class="function" rel="rdfs-seeAlso">oci_fetch_array()</a> - Returns the next row from a query as an associative or numeric array</span></li> <li class="member"> <span class="function"><a href="function.oci-fetch-row.html" class="function" rel="rdfs-seeAlso">oci_fetch_row()</a> - Returns the next row from a query as a numeric array</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.oci-fetch-assoc.html">oci_fetch_assoc</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.oci-fetch-row.html">oci_fetch_row</a></div> <div class="up"><a href="ref.oci8.html">OCI8 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>