Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 2519

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!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 an object with properties representing columns in the fetched row</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.db2-fetch-both.html">db2_fetch_both</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.db2-fetch-row.html">db2_fetch_row</a></div>
 <div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.db2-fetch-object" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_fetch_object</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_fetch_object</span> &mdash; <span class="dc-title">
   Returns an object with properties representing columns in the fetched row
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.db2-fetch-object-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">object</span> <span class="methodname"><strong>db2_fetch_object</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stmt</code></span>
   [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$row_number</code><span class="initializer"> = -1</span></span>
  ] )</div>



  <p class="para rdfs-comment">
   Returns an object in which each property represents a column returned in
   the row fetched from a result set.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.db2-fetch-object-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">stmt</code></em></span>
     <dd>

      <p class="para">
       A valid <em>stmt</em> resource containing a result set.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">row_number</code></em></span>
     <dd>

      <p class="para">
       Requests a specific 1-indexed row from the result set. Passing this
       parameter results in a PHP warning if the result set uses a
       forward-only cursor.
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.db2-fetch-object-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns an object representing a single row in the result set. The
   properties of the object map to the names of the columns in the result set.
  </p>
  <p class="para">
   The IBM DB2, Cloudscape, and Apache Derby database servers typically fold
   column names to upper-case, so the object properties will reflect that case. 
  </p>
  <p class="para">
   If your SELECT statement calls a scalar function to modify the value
   of a column, the database servers return the column number as the name of
   the column in the result set. If you prefer a more descriptive column name
   and object property, you can use the AS clause to assign a name to the
   column in the result set.
  </p>
  <p class="para">
   Returns <strong><code>FALSE</code></strong> if no row was retrieved.
  </p>
 </div>


<div class="refsect1 examples" id="refsect1-function.db2-fetch-object-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1169">
    <p><strong>Example #1 A  <span class="function"><strong>db2_fetch_object()</strong></span> example</strong></p>
    <div class="example-contents"><p>
     The following example issues a SELECT statement with a scalar function,
     RTRIM, that removes whitespace from the end of the column. Rather than
     creating an object with the properties &quot;BREED&quot; and &quot;2&quot;, we use the AS
     clause in the SELECT statement to assign the name &quot;name&quot; to the modified
     column. The database server folds the column names to upper-case,
     resulting in an object with the properties &quot;BREED&quot; and &quot;NAME&quot;.
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$conn&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$user</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$sql&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"SELECT&nbsp;breed,&nbsp;RTRIM(name)&nbsp;AS&nbsp;name<br />&nbsp;&nbsp;&nbsp;&nbsp;FROM&nbsp;animals<br />&nbsp;&nbsp;&nbsp;&nbsp;WHERE&nbsp;id&nbsp;=&nbsp;?"</span><span style="color: #007700">;<br /><br />if&nbsp;(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$stmt&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">db2_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">db2_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">,&nbsp;array(</span><span style="color: #0000BB">0</span><span style="color: #007700">));<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;while&nbsp;(</span><span style="color: #0000BB">$pet&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">db2_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">))&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Come&nbsp;here,&nbsp;</span><span style="color: #007700">{</span><span style="color: #0000BB">$pet</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">NAME</span><span style="color: #007700">}</span><span style="color: #DD0000">,&nbsp;my&nbsp;little&nbsp;</span><span style="color: #007700">{</span><span style="color: #0000BB">$pet</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">BREED</span><span style="color: #007700">}</span><span style="color: #DD0000">!"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">db2_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents"><p>The above example will output:</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
Come here, Pook, my little cat!
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.db2-fetch-object-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"> <span class="function"><a href="function.db2-fetch-array.html" class="function" rel="rdfs-seeAlso">db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</span></li>
    <li class="member"> <span class="function"><a href="function.db2-fetch-assoc.html" class="function" rel="rdfs-seeAlso">db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</span></li>
    <li class="member"> <span class="function"><a href="function.db2-fetch-both.html" class="function" rel="rdfs-seeAlso">db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</span></li>
    <li class="member"> <span class="function"><a href="function.db2-fetch-row.html" class="function" rel="rdfs-seeAlso">db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</span></li>
    <li class="member"> <span class="function"><a href="function.db2-result.html" class="function" rel="rdfs-seeAlso">db2_result()</a> - Returns a single column from a row in the result set</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.db2-fetch-both.html">db2_fetch_both</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.db2-fetch-row.html">db2_fetch_row</a></div>
 <div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>