<!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>Gets a record from a database as an associative array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.dbase-get-header-info.html">dbase_get_header_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dbase-get-record.html">dbase_get_record</a></div>
<div class="up"><a href="ref.dbase.html">dBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.dbase-get-record-with-names" class="refentry">
<div class="refnamediv">
<h1 class="refname">dbase_get_record_with_names</h1>
<p class="verinfo">(PHP 5 < 5.3.0, dbase 5, dbase 7)</p><p class="refpurpose"><span class="refname">dbase_get_record_with_names</span> — <span class="dc-title">
Gets a record from a database as an associative array
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.dbase-get-record-with-names-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>dbase_get_record_with_names</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dbase_identifier</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$record_number</code></span>
)</div>
<p class="para rdfs-comment">
Gets a record from a dBase database as an associative array.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.dbase-get-record-with-names-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">dbase_identifier</code></dt>
<dd>
<p class="para">
The database link identifier, returned by <span class="function"><a href="function.dbase-open.html" class="function">dbase_open()</a></span>
or <span class="function"><a href="function.dbase-create.html" class="function">dbase_create()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">record_number</code></dt>
<dd>
<p class="para">
The index of the record between <em>1</em> and
<em>dbase_numrecords($dbase_identifier)</em>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.dbase-get-record-with-names-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An associative array with the record. This will also include a key named
<em>deleted</em> which is set to 1 if the record has been marked
for deletion (see <span class="function"><a href="function.dbase-delete-record.html" class="function">dbase_delete_record()</a></span>).
Therefore it is not possible to retrieve the value of a field named
<em>deleted</em> with this function.
</p>
<p class="para">
Each field is converted to the appropriate PHP type, except:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
Dates are left as strings.
</span>
</li>
<li class="listitem">
<span class="simpara">
DateTime values are converted to strings.
</span>
</li>
<li class="listitem">
<span class="simpara">
Integers outside the range
<strong><code>PHP_INT_MIN</code></strong>..<strong><code>PHP_INT_MAX</code></strong> are
returned as strings.
</span>
</li>
<li class="listitem">
<span class="simpara">
Before dbase 7.0.0, booleans (<em>L</em>) were converted to <em>1</em> or
<em>0</em>.
</span>
</li>
</ul>
</p>
<p class="para">
On error, <span class="function"><strong>dbase_get_record_with_names()</strong></span> will return <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.dbase-get-record-with-names-changelog">
<h3 class="title">Changelog</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>dbase 7.0.0</td>
<td>
<code class="parameter">dbase_identifier</code> is now a <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span>
instead of an <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-function.dbase-get-record-with-names-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1221">
<p><strong>Example #1 Listing all the registered members in the database</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// open in read-only mode<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'/tmp/test.dbf'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$db</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$record_numbers </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_numrecords</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">);<br /> for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700"><= </span><span style="color: #0000BB">$record_numbers</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">dbase_get_record_with_names</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'ismember'</span><span style="color: #007700">] == </span><span style="color: #0000BB">1</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Member #</span><span style="color: #0000BB">$i</span><span style="color: #DD0000">: " </span><span style="color: #007700">. </span><span style="color: #0000BB">trim</span><span style="color: #007700">(</span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #DD0000">'name'</span><span style="color: #007700">]) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> }<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.dbase-get-record-with-names-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.dbase-get-record.html" class="function" rel="rdfs-seeAlso">dbase_get_record()</a> - Gets a record from a database as an indexed 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.dbase-get-header-info.html">dbase_get_header_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.dbase-get-record.html">dbase_get_record</a></div>
<div class="up"><a href="ref.dbase.html">dBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
