The MongoDB\BSON\Binary class

(mongodb >=1.0.0)


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.

Class synopsis

final MongoDB\BSON\Binary implements MongoDB\BSON\BinaryInterface , MongoDB\BSON\Type , Serializable , JsonSerializable {
/* Constants */
const integer TYPE_GENERIC = 0 ;
const integer TYPE_FUNCTION = 1 ;
const integer TYPE_OLD_BINARY = 2 ;
const integer TYPE_OLD_UUID = 3 ;
const integer TYPE_UUID = 4 ;
const integer TYPE_MD5 = 5 ;
const integer TYPE_USER_DEFINED = 128 ;
/* Methods */
final public __construct ( string $data , int $type )
final public string getData ( void )
final public int getType ( void )
final public mixed jsonSerialize ( void )
final public string serialize ( void )
final public string __toString ( void )
final public void unserialize ( string $serialized )

Predefined Constants


Generic binary data.




Generic binary data (deprecated in favor of MongoDB\BSON\Binary::TYPE_GENERIC).


Universally unique identifier (deprecated in favor of MongoDB\BSON\Binary::TYPE_UUID). When using this type, the Binary's data should be 16 bytes in length.

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.


Universally unique identifier. When using this type, the Binary's data should be 16 bytes in length and encoded according to » RFC 4122.


MD5 hash. When using this type, the Binary's data should be 16 bytes in length.


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.


Version Description
1.2.0 Implements Serializable and JsonSerializable.

Table of Contents

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top