php-doc-en/reference/mongo/mongobindata/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="mongobindata.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoBinData::__construct</refname>
  <refpurpose>Creates a new binary data object.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>MongoBinData::__construct</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>2</initializer></methodparam>
  </methodsynopsis>
  <para>
   Creates a new binary data object.
  </para>
  <para>
   There are five types of binary data currently recognized by the BSON spec:
   function (0x01), byte array (0x02), UUID (0x03), MD5 (0x05), and user defined 
   (0x80).  The default type is byte array (0x02).  There is no particular 
   difference in how the driver or server interpret different types, so by and
   large they are irrelevant for now.  Any number (between 0 and 255) could be 
   used for type, if the user is willing to assume the risk that the database
   might eventually do something with binary data based on type.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>data</parameter>
     </term>
     <listitem>
      <para>
       Binary data.
      </para>
     </listitem>
    </varlistentry>     
    <varlistentry>
     <term>
      <parameter>type</parameter>
     </term>
     <listitem>
      <para>
       Data type.
      </para>
     </listitem>
    </varlistentry>     
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a new binary data object.
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->