<!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 Binary</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-bson-binary.html">MongoDB\BSON\Binary</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-binary.getdata.html">MongoDB\BSON\Binary::getData</a></div> <div class="up"><a href="class.mongodb-bson-binary.html">MongoDB\BSON\Binary</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-bson-binary.construct" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\BSON\Binary::__construct</h1> <p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\BSON\Binary::__construct</span> — <span class="dc-title">Construct a new Binary</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-bson-binary.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\Binary::__construct</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span> )</div> </div> <div class="refsect1 parameters" id="refsect1-mongodb-bson-binary.construct-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">data</code> (<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)</dt> <dd> <p class="para"> Binary data. </p> </dd> <dt> <code class="parameter">type</code> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)</dt> <dd> <p class="para"> Unsigned 8-bit integer denoting the data's type. </p> </dd> </dl> </div> <div class="refsect1 errors" id="refsect1-mongodb-bson-binary.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">type</code> is not an unsigned 8-bit integer.</li> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if <code class="parameter">type</code> is <strong><code>MongoDB\BSON\Binary::TYPE_UUID</code></strong> or <strong><code>MongoDB\BSON\Binary::TYPE_OLD_UUID</code></strong> and <code class="parameter">data</code> is not exactly 16 bytes in length.</li> </ul> </div> <div class="refsect1 changelog" id="refsect1-mongodb-bson-binary.construct-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>1.3.0</td> <td> <p class="para"> <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> is thrown if <code class="parameter">type</code> is <strong><code>MongoDB\BSON\Binary::TYPE_UUID</code></strong> or <strong><code>MongoDB\BSON\Binary::TYPE_OLD_UUID</code></strong> and <code class="parameter">data</code> is not exactly 16 bytes in length. </p> </td> </tr> <tr> <td>1.1.3</td> <td> <p class="para"> <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> is thrown if <code class="parameter">type</code> is not an unsigned 8-bit integer. </p> </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-mongodb-bson-binary.construct-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1758"> <p><strong>Example #1 <span class="function"><strong>MongoDB\BSON\Binary::__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 />$binary </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">Binary</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </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">Binary</span><span style="color: #007700">::</span><span style="color: #0000BB">TYPE_GENERIC</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$binary</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:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> object(MongoDB\BSON\Binary)#1 (2) { ["data"]=> string(3) "foo" ["type"]=> int(0) } </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mongodb-bson-binary.construct-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><a href="https://docs.mongodb.com/manual/reference/bson-types/" class="link external">» BSON Types</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-binary.html">MongoDB\BSON\Binary</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-binary.getdata.html">MongoDB\BSON\Binary::getData</a></div> <div class="up"><a href="class.mongodb-bson-binary.html">MongoDB\BSON\Binary</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>