<!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>Creates a database reference</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocollection.count.html">MongoCollection::count</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocollection.deleteindex.html">MongoCollection::deleteIndex</a></div>
<div class="up"><a href="class.mongocollection.html">MongoCollection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongocollection.createdbref" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCollection::createDBRef</h1>
<p class="verinfo">(PECL mongo >=0.9.0)</p><p class="refpurpose"><span class="refname">MongoCollection::createDBRef</span> — <span class="dc-title">Creates a database reference</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocollection.createdbref-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>MongoCollection::createDBRef</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$document_or_id</code></span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongocollection.createdbref-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">document_or_id</code></em>
</span>
<dd>
<p class="para">
If an array or object is given, its <em>_id</em> field will be
used as the reference ID. If a <a href="class.mongoid.html" class="classname">MongoId</a> or scalar
is given, it will be used as the reference ID.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocollection.createdbref-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a database reference array.
</p>
<p class="para">
If an array without an <em>_id</em> field was provided as the
<em>document_or_id</em> parameter, <strong><code>NULL</code></strong> will be returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongocollection.createdbref-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1437">
<p><strong>Example #1 <span class="methodname"><strong>MongoCollection::createDBRef()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$songs </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">songs</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$playlists </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">playlists</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// create a reference to a song<br /></span><span style="color: #0000BB">$manamana </span><span style="color: #007700">= </span><span style="color: #0000BB">$songs</span><span style="color: #007700">-></span><span style="color: #0000BB">findOne</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'title' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Ma na ma na'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$refToSong </span><span style="color: #007700">= </span><span style="color: #0000BB">$songs</span><span style="color: #007700">-></span><span style="color: #0000BB">createDBRef</span><span style="color: #007700">(</span><span style="color: #0000BB">$manamana</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// add the reference to my playlist<br /></span><span style="color: #0000BB">$playlists</span><span style="color: #007700">-></span><span style="color: #0000BB">update</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'username' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'me'</span><span style="color: #007700">), array(</span><span style="color: #DD0000">'$push' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'songlist' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$refToSong</span><span style="color: #007700">)));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongocollection.createdbref-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="mongocollection.getdbref.html" class="methodname" rel="rdfs-seeAlso">MongoCollection::getDBRef()</a> - Fetches the document pointed to by a database reference</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="mongocollection.count.html">MongoCollection::count</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocollection.deleteindex.html">MongoCollection::deleteIndex</a></div>
<div class="up"><a href="class.mongocollection.html">MongoCollection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
