Document MongoDB\BSON\Binary type constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341738 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeremy Mikola 2017-01-19 23:53:11 +00:00
parent e32c9f1225
commit 14933383d1

View file

@ -98,49 +98,50 @@
<varlistentry xml:id="mongodb-bson-binary.constants.type-generic">
<term><constant>MongoDB\BSON\Binary::TYPE_GENERIC</constant></term>
<listitem>
<para></para>
<para>Generic binary data.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-bson-binary.constants.type-function">
<term><constant>MongoDB\BSON\Binary::TYPE_FUNCTION</constant></term>
<listitem>
<para></para>
<para>Function.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-bson-binary.constants.type-old-binary">
<term><constant>MongoDB\BSON\Binary::TYPE_OLD_BINARY</constant></term>
<listitem>
<para></para>
<para>Generic binary data (deprecated in favor of <constant>MongoDB\BSON\Binary::TYPE_GENERIC</constant>).</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-bson-binary.constants.type-old-uuid">
<term><constant>MongoDB\BSON\Binary::TYPE_OLD_UUID</constant></term>
<listitem>
<para></para>
<para>Universally unique identifier (deprecated in favor of <constant>MongoDB\BSON\Binary::TYPE_UUID</constant>). When using this type, the Binary&apos;s data should be 16 bytes in length.</para>
<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.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-bson-binary.constants.type-uuid">
<term><constant>MongoDB\BSON\Binary::TYPE_UUID</constant></term>
<listitem>
<para></para>
<para>Universally unique identifier. When using this type, the Binary&apos;s data should be 16 bytes in length and encoded according to <link xlink:href="&url.rfc;4122">RFC 4122</link>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-bson-binary.constants.type-md5">
<term><constant>MongoDB\BSON\Binary::TYPE_MD5</constant></term>
<listitem>
<para></para>
<para>MD5 hash. When using this type, the Binary&apos;s data should be 16 bytes in length.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongodb-bson-binary.constants.type-user-defined">
<term><constant>MongoDB\BSON\Binary::TYPE_USER_DEFINED</constant></term>
<listitem>
<para></para>
<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.</para>
</listitem>
</varlistentry>