<!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 id</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongoid.html">MongoId</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoid.gethostname.html">MongoId::getHostname</a></div>
<div class="up"><a href="class.mongoid.html">MongoId</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongoid.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoId::__construct</h1>
<p class="verinfo">(PECL mongo >= 0.8.0)</p><p class="refpurpose"><span class="refname">MongoId::__construct</span> — <span class="dc-title">Creates a new id</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongoid.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>MongoId::__construct</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongoid.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">id</code></em>
</span>
<dd>
<p class="para">
A string to use as the id. Must be 24 hexidecimal characters. If an
invalid string is passed to this constructor, the constructor will ignore
it and create a new id value.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongoid.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a new id.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongoid.construct-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1489">
<p><strong>Example #1 <span class="function"><strong>MongoId::__construct()</strong></span> example</strong></p>
<div class="example-contents"><p>
This example shows how to create a new id. This is seldom necessary, as the
driver adds an id to arrays automatically before storing them in the
database.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /> $id1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">();<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$id1</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$id2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">();<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$id2</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
49a7011a05c677b9a916612a
49a702d5450046d3d515d10d
</pre></div>
</div>
</div>
<div class="example" id="example-1490">
<p><strong>Example #2 Parameter example</strong></p>
<div class="example-contents"><p>This example shows how to use a string parameter to initialize a MongoId with a given value.</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $id1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">();<br /><br /> </span><span style="color: #FF8000">// create a new id from $id1<br /> </span><span style="color: #0000BB">$id2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">"</span><span style="color: #0000BB">$id1</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// show that $id1 and $id2 have the same hexidecimal value<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$id1 </span><span style="color: #007700">== </span><span style="color: #0000BB">$id2</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(true)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongoid.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="mongoid.tostring.html" class="methodname" rel="rdfs-seeAlso">MongoId::__toString()</a> - Returns a hexidecimal representation of this id</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.mongoid.html">MongoId</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoid.gethostname.html">MongoId::getHostname</a></div>
<div class="up"><a href="class.mongoid.html">MongoId</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
