<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/mongodb.bson.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'uk',
  ),
  'this' => 
  array (
    0 => 'class.mongodb-bson-binary.php',
    1 => 'MongoDB\\BSON\\Binary',
    2 => 'The MongoDB\\BSON\\Binary class',
  ),
  'up' => 
  array (
    0 => 'mongodb.bson.php',
    1 => 'MongoDB\\BSON',
  ),
  'prev' => 
  array (
    0 => 'mongodb-bson-iterator.valid.php',
    1 => 'MongoDB\\BSON\\Iterator::valid',
  ),
  'next' => 
  array (
    0 => 'mongodb-bson-binary.construct.php',
    1 => 'MongoDB\\BSON\\Binary::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mongodb/bson/binary.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.mongodb-bson-binary.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.mongodb-bson-binary" class="reference">

 <h1 class="title">The MongoDB\BSON\Binary class</h1>
 

 <div class="partintro"><p class="verinfo">(mongodb &gt;=1.0.0)</p>


  <div class="section" id="mongodb-bson-binary.intro">
   <h2 class="title">Вступ</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">Короткий огляд класу</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="modifier">final</span>
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">MongoDB\BSON\Binary</strong>
     </span>

     <span class="oointerface"><span class="modifier">implements</span> 
       <a href="class.mongodb-bson-binaryinterface.php" class="interfacename">MongoDB\BSON\BinaryInterface</a></span><span class="oointerface">,  <a href="class.mongodb-bson-type.php" class="interfacename">MongoDB\BSON\Type</a></span><span class="oointerface">,  <a href="class.jsonserializable.php" class="interfacename">JsonSerializable</a></span><span class="oointerface">,  <a href="class.stringable.php" class="interfacename">Stringable</a></span> {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Константи */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-encrypted"><var class="varname">TYPE_ENCRYPTED</var></a></var><span class="initializer"> = 6</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-column"><var class="varname">TYPE_COLUMN</var></a></var><span class="initializer"> = 7</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-sensitive"><var class="varname">TYPE_SENSITIVE</var></a></var><span class="initializer"> = 8</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-bson-binary.php#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">/* Методи */</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.php" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = MongoDB\BSON\Binary::TYPE_GENERIC</span></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-binary.getdata.php" class="methodname">getData</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-binary.gettype.php" class="methodname">getType</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-binary.jsonserialize.php" class="methodname">jsonSerialize</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-binary.tostring.php" class="methodname">__toString</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

   }</div>


  </div>


  <div class="section" id="mongodb-bson-binary.constants">
   <h2 class="title">Попередньо визначені константи</h2>
   <dl>

    
     <dt id="mongodb-bson-binary.constants.type-generic"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-generic">MongoDB\BSON\Binary::TYPE_GENERIC</a></code></strong></dt>
     <dd>
      <p class="para">Generic binary data.</p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-function"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-function">MongoDB\BSON\Binary::TYPE_FUNCTION</a></code></strong></dt>
     <dd>
      <p class="para">Function.</p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-old-binary"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-old-binary">MongoDB\BSON\Binary::TYPE_OLD_BINARY</a></code></strong></dt>
     <dd>
      <p class="para">Generic binary data (deprecated in favor of <strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-generic">MongoDB\BSON\Binary::TYPE_GENERIC</a></code></strong>).</p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-old-uuid"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-old-uuid">MongoDB\BSON\Binary::TYPE_OLD_UUID</a></code></strong></dt>
     <dd>
      <p class="para">
       Universally unique identifier (deprecated in favor of
       <strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-uuid">MongoDB\BSON\Binary::TYPE_UUID</a></code></strong>). When using this
       type, the Binary&#039;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 extension applies no special handling for encoding
       or decoding data with this type.
      </p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-uuid"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-uuid">MongoDB\BSON\Binary::TYPE_UUID</a></code></strong></dt>
     <dd>
      <p class="para">
       Universally unique identifier. When using this type, the Binary&#039;s
       data should be 16 bytes in length and encoded according to
       <a href="https://datatracker.ietf.org/doc/html/rfc4122" class="link external">&raquo;&nbsp;RFC 4122</a>.
      </p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-md5"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-md5">MongoDB\BSON\Binary::TYPE_MD5</a></code></strong></dt>
     <dd>
      <p class="para">MD5 hash. When using this type, the Binary&#039;s data should be 16 bytes in length.</p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-encrypted"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-encrypted">MongoDB\BSON\Binary::TYPE_ENCRYPTED</a></code></strong></dt>
     <dd>
      <p class="para">Encrypted value. This subtype is used for client-side encryption.</p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-column"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-column">MongoDB\BSON\Binary::TYPE_COLUMN</a></code></strong></dt>
     <dd>
      <p class="para">Column data. This subtype is used for time-series collections.</p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-sensitive"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-sensitive">MongoDB\BSON\Binary::TYPE_SENSITIVE</a></code></strong></dt>
     <dd>
      <p class="para">
       Sensitive data. This subtype is used for sensitive data that should be
       excluded from server-side logging when possible.
      </p>
     </dd>
    

    
     <dt id="mongodb-bson-binary.constants.type-user-defined"><strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-user-defined">MongoDB\BSON\Binary::TYPE_USER_DEFINED</a></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">Журнал змін</h2>
   <p class="para">
    <table class="doctable informaltable">
     
      <thead>
       <tr>
        <th>Версія</th>
        <th>Опис</th>
       </tr>

      </thead>

      <tbody class="tbody">
       
       <tr>
        <td>PECL mongodb 2.0.0</td>
        <td>
         <p class="para">
          This class no longer implements the
          <span class="interfacename"><a href="class.serializable.php" class="interfacename">Serializable</a></span> interface.
         </p>
        </td>
       </tr>


       <tr>
        <td>PECL mongodb 1.17.0</td>
        <td>
         Added <strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-sensitive">MongoDB\BSON\Binary::TYPE_SENSITIVE</a></code></strong>.
        </td>
       </tr>

       <tr>
        <td>PECL mongodb 1.12.0</td>
        <td>
         <p class="para">
          Implements <span class="interfacename"><a href="class.stringable.php" class="interfacename">Stringable</a></span> for PHP 8.0+.
         </p>
         <p class="para">
          Added <strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-column">MongoDB\BSON\Binary::TYPE_COLUMN</a></code></strong>.
         </p>
        </td>
       </tr>

       <tr>
        <td>PECL mongodb 1.7.0</td>
        <td>
         Added <strong><code><a href="class.mongodb-bson-binary.php#mongodb-bson-binary.constants.type-encrypted">MongoDB\BSON\Binary::TYPE_ENCRYPTED</a></code></strong>.
        </td>
       </tr>

       <tr>
        <td>PECL mongodb 1.3.0</td>
        <td>
         Implements <span class="interfacename"><a href="class.mongodb-bson-binaryinterface.php" class="interfacename">MongoDB\BSON\BinaryInterface</a></span>.
        </td>
       </tr>

       <tr>
        <td>PECL mongodb 1.2.0</td>
        <td>
         Implements <span class="interfacename"><a href="class.serializable.php" class="interfacename">Serializable</a></span> and
         <span class="interfacename"><a href="class.jsonserializable.php" class="interfacename">JsonSerializable</a></span>.
        </td>
       </tr>

      </tbody>
     
    </table>

   </p>
  </div>

 </div>

 







 






 






 






 






<h2>Зміст</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-bson-binary.construct.php">MongoDB\BSON\Binary::__construct</a> — Construct a new Binary</li><li><a href="mongodb-bson-binary.getdata.php">MongoDB\BSON\Binary::getData</a> — Returns the Binary's data</li><li><a href="mongodb-bson-binary.gettype.php">MongoDB\BSON\Binary::getType</a> — Returns the Binary's type</li><li><a href="mongodb-bson-binary.jsonserialize.php">MongoDB\BSON\Binary::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="mongodb-bson-binary.tostring.php">MongoDB\BSON\Binary::__toString</a> — Returns the Binary's data</li></ul>
</div>
<?php manual_footer($setup); ?>