<!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>The MongoDB\BSON\Binary class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mongodb.bson-torelaxedextendedjson.html">MongoDB\BSON\toRelaxedExtendedJSON</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-binary.construct.html">MongoDB\BSON\Binary::__construct</a></div>
<div class="up"><a href="book.bson.html">MongoDB\BSON</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongodb-bson-binary" class="reference">
<h1 class="title">The MongoDB\BSON\Binary class</h1>
<div class="partintro"><p class="verinfo">(mongodb >=1.0.0)</p>
<div class="section" id="mongodb-bson-binary.intro">
<h2 class="title">Introduction</h2>
<p class="para">
BSON type for binary data (i.e. array of bytes). Binary values also have a
subtype, which is used to indicate what kind of data is in the byte array.
Subtypes from zero to 127 are predefined or reserved. Subtypes from 128-255
are user-defined.
</p>
</div>
<div class="section" id="mongodb-bson-binary.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="modifier">final</span>
<span class="ooclass">
<strong class="classname">MongoDB\BSON\Binary</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.mongodb-bson-binaryinterface.html" class="interfacename">MongoDB\BSON\BinaryInterface</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.mongodb-bson-type.html" class="interfacename">MongoDB\BSON\Type</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-generic"><var class="varname">TYPE_GENERIC</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-function"><var class="varname">TYPE_FUNCTION</var></a></var>
<span class="initializer"> = 1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-old-binary"><var class="varname">TYPE_OLD_BINARY</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-old-uuid"><var class="varname">TYPE_OLD_UUID</var></a></var>
<span class="initializer"> = 3</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-uuid"><var class="varname">TYPE_UUID</var></a></var>
<span class="initializer"> = 4</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-md5"><var class="varname">TYPE_MD5</var></a></var>
<span class="initializer"> = 5</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-user-defined"><var class="varname">TYPE_USER_DEFINED</var></a></var>
<span class="initializer"> = 128</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-binary.construct.html" class="methodname">__construct</a></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 class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-binary.getdata.html" class="methodname">getData</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="mongodb-bson-binary.gettype.html" class="methodname">getType</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="mongodb-bson-binary.jsonserialize.html" class="methodname">jsonSerialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-binary.serialize.html" class="methodname">serialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-binary.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-bson-binary.unserialize.html" class="methodname">unserialize</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$serialized</code></span>
)</div>
}</div>
</div>
<div class="section" id="mongodb-bson-binary.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="mongodb-bson-binary.constants.type-generic"><strong><code>MongoDB\BSON\Binary::TYPE_GENERIC</code></strong></dt>
<dd>
<p class="para">Generic binary data.</p>
</dd>
<dt id="mongodb-bson-binary.constants.type-function"><strong><code>MongoDB\BSON\Binary::TYPE_FUNCTION</code></strong></dt>
<dd>
<p class="para">Function.</p>
</dd>
<dt id="mongodb-bson-binary.constants.type-old-binary"><strong><code>MongoDB\BSON\Binary::TYPE_OLD_BINARY</code></strong></dt>
<dd>
<p class="para">Generic binary data (deprecated in favor of <strong><code>MongoDB\BSON\Binary::TYPE_GENERIC</code></strong>).</p>
</dd>
<dt id="mongodb-bson-binary.constants.type-old-uuid"><strong><code>MongoDB\BSON\Binary::TYPE_OLD_UUID</code></strong></dt>
<dd>
<p class="para">Universally unique identifier (deprecated in favor of <strong><code>MongoDB\BSON\Binary::TYPE_UUID</code></strong>). When using this type, the Binary's data should be 16 bytes in length.</p>
<p class="para">Historically, other drivers encoded values with this type based on their language conventions (e.g. varying endianness), which makes it non-portable. The PHP driver applies no special handling for encoding or decoding data with this type.</p>
</dd>
<dt id="mongodb-bson-binary.constants.type-uuid"><strong><code>MongoDB\BSON\Binary::TYPE_UUID</code></strong></dt>
<dd>
<p class="para">Universally unique identifier. When using this type, the Binary's data should be 16 bytes in length and encoded according to <a href="http://www.faqs.org/rfcs/rfc4122" class="link external">» RFC 4122</a>.</p>
</dd>
<dt id="mongodb-bson-binary.constants.type-md5"><strong><code>MongoDB\BSON\Binary::TYPE_MD5</code></strong></dt>
<dd>
<p class="para">MD5 hash. When using this type, the Binary's data should be 16 bytes in length.</p>
</dd>
<dt id="mongodb-bson-binary.constants.type-user-defined"><strong><code>MongoDB\BSON\Binary::TYPE_USER_DEFINED</code></strong></dt>
<dd>
<p class="para">User-defined type. While types between 0 and 127 are predefined or reserved, types between 128 and 255 are user-defined and may be used for anything.</p>
</dd>
</dl>
</div>
<div class="section">
<h2 class="title">Changelog</h2>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.2.0</td>
<td>
Implements <span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span> and
<span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-bson-binary.construct.html">MongoDB\BSON\Binary::__construct</a> — Construct a new Binary</li><li><a href="mongodb-bson-binary.getdata.html">MongoDB\BSON\Binary::getData</a> — Returns the Binary's data</li><li><a href="mongodb-bson-binary.gettype.html">MongoDB\BSON\Binary::getType</a> — Returns the Binary's type</li><li><a href="mongodb-bson-binary.jsonserialize.html">MongoDB\BSON\Binary::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="mongodb-bson-binary.serialize.html">MongoDB\BSON\Binary::serialize</a> — Serialize a Binary</li><li><a href="mongodb-bson-binary.tostring.html">MongoDB\BSON\Binary::__toString</a> — Returns the Binary's data</li><li><a href="mongodb-bson-binary.unserialize.html">MongoDB\BSON\Binary::unserialize</a> — Unserialize a Binary</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mongodb.bson-torelaxedextendedjson.html">MongoDB\BSON\toRelaxedExtendedJSON</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-binary.construct.html">MongoDB\BSON\Binary::__construct</a></div>
<div class="up"><a href="book.bson.html">MongoDB\BSON</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
