<!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>Construct a new ObjectId</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-bson-objectid.html">MongoDB\BSON\ObjectId</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-objectid.gettimestamp.html">MongoDB\BSON\ObjectId::getTimestamp</a></div>
<div class="up"><a href="class.mongodb-bson-objectid.html">MongoDB\BSON\ObjectId</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-bson-objectid.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\BSON\ObjectId::__construct</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\BSON\ObjectId::__construct</span> — <span class="dc-title">Construct a new ObjectId</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-bson-objectid.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\BSON\ObjectId::__construct</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-bson-objectid.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">id</code> (<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)</dt>
<dd>
<p class="para">
A 24-character hexadecimal string. If not provided, the driver will
generate an ObjectId.
</p>
</dd>
</dl>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-bson-objectid.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if <code class="parameter">id</code> is not a 24-character hexadecimal string.</li>
</ul>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-bson-objectid.construct-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1770">
<p><strong>Example #1 <span class="function"><strong>MongoDB\BSON\ObjectId::__construct()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />var_dump</span><span style="color: #007700">(new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">ObjectId</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">ObjectId</span><span style="color: #007700">(</span><span style="color: #DD0000">'000000000000000000000001'</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>
object(MongoDB\BSON\ObjectId)#1 (1) {
["oid"]=>
string(24) "56732d3dda14d81214634921"
}
object(MongoDB\BSON\ObjectId)#1 (1) {
["oid"]=>
string(24) "000000000000000000000001"
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-bson-objectid.construct-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="https://docs.mongodb.com/manual/reference/object-id/" class="link external">» ObjectId Reference</a></li>
<li class="member"><a href="https://docs.mongodb.com/manual/reference/bson-types/#objectid" class="link external">» BSON Types: ObjectId</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-bson-objectid.html">MongoDB\BSON\ObjectId</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-objectid.gettimestamp.html">MongoDB\BSON\ObjectId::getTimestamp</a></div>
<div class="up"><a href="class.mongodb-bson-objectid.html">MongoDB\BSON\ObjectId</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
