<!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>Fetches the document pointed to by a database reference</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.getcollectionnames.html">MongoDB::getCollectionNames</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getgridfs.html">MongoDB::getGridFS</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb.getdbref" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB::getDBRef</h1>
<p class="verinfo">(PECL mongo >=0.9.0)</p><p class="refpurpose"><span class="refname">MongoDB::getDBRef</span> — <span class="dc-title">Fetches the document pointed to by a database reference</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb.getdbref-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoDB::getDBRef</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$ref</code></span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb.getdbref-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">ref</code></em>
</span>
<dd>
<p class="para">
A database reference.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb.getdbref-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the document pointed to by the reference.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb.getdbref-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1423">
<p><strong>Example #1 <span class="function"><strong>MongoDB::getDBRef()</strong></span> example</strong></p>
<div class="example-contents"><p>
Example demonstrating how to get a database reference and what the expected
input is.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /> $ref </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'$ref' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'profiles'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'$id' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">'47cc67093475061e3d9536d2'</span><span style="color: #007700">)<br /> );<br /> <br /> </span><span style="color: #0000BB">$profile </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">getDBRef</span><span style="color: #007700">(</span><span style="color: #0000BB">$ref</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
See <span class="function"><a href="mongodb.createdbref.html" class="function">MongoDB::createDBRef()</a></span> for more information about how to programatically create DB references.
</p></div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.getcollectionnames.html">MongoDB::getCollectionNames</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getgridfs.html">MongoDB::getGridFS</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
