<!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 new database reference</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodbref.html">MongoDBRef</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodbref.get.html">MongoDBRef::get</a></div>
<div class="up"><a href="class.mongodbref.html">MongoDBRef</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodbref.create" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDBRef::create</h1>
<p class="verinfo">(PECL mongo >= 0.9.0)</p><p class="refpurpose"><span class="refname">MongoDBRef::create</span> — <span class="dc-title">Creates a new database reference</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodbref.create-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">array</span> <span class="methodname"><strong>MongoDBRef::create</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$collection</code></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">$id</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$database</code></span>
] )</div>
<p class="para rdfs-comment">
If no database is given, the current database is used.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodbref.create-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">collection</code></em>
</span>
<dd>
<p class="para">
Collection name (without the database name).
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">id</code></em>
</span>
<dd>
<p class="para">
The _id field of the object to which to link.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">database</code></em>
</span>
<dd>
<p class="para">
Database name.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodbref.create-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the reference.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodbref.create-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1503">
<p><strong>Example #1 <span class="function"><strong>MongoDBRef::create()</strong></span> example</strong></p>
<div class="example-contents"><p>
This creates a database reference to a document in the
<em>addresses</em> collection. The
<span class="function"><a href="mongocollection.getname.html" class="function">MongoCollection::getName()</a></span> function returns the name of
the collection (not including the database name).
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$addresses </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">addresses</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$people </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">people</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// save $address so it has an _id<br /></span><span style="color: #0000BB">$addresses</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">(</span><span style="color: #0000BB">$address</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// create a reference<br /></span><span style="color: #0000BB">$ref </span><span style="color: #007700">= </span><span style="color: #0000BB">MongoDBRef</span><span style="color: #007700">::</span><span style="color: #0000BB">create</span><span style="color: #007700">(</span><span style="color: #0000BB">$addresses</span><span style="color: #007700">-></span><span style="color: #0000BB">getName</span><span style="color: #007700">(), </span><span style="color: #0000BB">$address</span><span style="color: #007700">[</span><span style="color: #DD0000">'_id'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #FF8000">// set the field in $person<br /></span><span style="color: #0000BB">$person</span><span style="color: #007700">[</span><span style="color: #DD0000">'address'</span><span style="color: #007700">] = </span><span style="color: #0000BB">$ref</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$people</span><span style="color: #007700">-></span><span style="color: #0000BB">save</span><span style="color: #007700">(</span><span style="color: #0000BB">$person</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodbref.create-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="mongodb.createdbref.html" class="methodname" rel="rdfs-seeAlso">MongoDB::createDBRef()</a> - Creates a database reference</span></li>
<li class="member"> <span class="methodname"><a href="mongocollection.createdbref.html" class="methodname" rel="rdfs-seeAlso">MongoCollection::createDBRef()</a> - Creates 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="class.mongodbref.html">MongoDBRef</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodbref.get.html">MongoDBRef::get</a></div>
<div class="up"><a href="class.mongodbref.html">MongoDBRef</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
