MONGOBINDATA(3) 1 MONGOBINDATA(3)
The MongoBinData class
INTRODUCTION
An object that can be used to store or retrieve binary data from the database.
The maximum size of a single object that can be inserted into the database is 16MB. For data that is larger than this (movies, music,
Henry Kissinger's autobiography), use MongoGridFS. For data that is smaller than 16MB, you may find it easier to embed it within the docu-
ment using MongoBinData.
For example, to embed an image in a document, one could write:
Example #1
<?php
$profile = array(
"username" => "foobity",
"pic" => new MongoBinData(file_get_contents("gravatar.jpg"), MongoBinData::GENERIC),
);
$users->save($profile);
?>
This class contains a $type field, which currently gives no additional functionality in the PHP driver or the database. There are seven
predefined types, which are defined as class constants below. For backwards compatibility, the PHP driver uses MongoBinData::BYTE_ARRAY as
the default; however, this may change to MongoBinData::GENERIC in the future. Users are encouraged to specify a type in MongoBinData.__con-
struct(3).
CLASS SYNOPSIS
MongoBinData
MongoBinData
Constants
o const int$MongoBinData::GENERIC0
o const int$MongoBinData::FUNC1
o const int$MongoBinData::BYTE_ARRAY2
o const int$MongoBinData::UUID3
o const int$MongoBinData::UUID_RFC41224
o const int$MongoBinData::MD55
o const int$MongoBinData::CUSTOM128
Fields
o public string$bin
o public int$type2
Methods
o public MongoBinData::__construct (string $data, [int $type])
o public string MongoBinData::__toString (void )
PREDEFINED CONSTANTS
BINARY DATA TYPES
o MongoBinData::GENERIC - 0x00 - Generic binary data.
o MongoBinData::FUNC - 0x01 - Function.
o MongoBinData::BYTE_ARRAY - 0x02 - Generic binary data (deprecated in favor of MongoBinData::GENERIC).
o MongoBinData::UUID - 0x03 - Universally unique identifier (deprecated in favor of MongoBinData::UUID_RFC4122).
o MongoBinData::UUID_RFC4122 - 0x04 - Universally unique identifier (according to RFC 4122).
o MongoBinData::MD5 - 0x05 - MD5.
o MongoBinData::CUSTOM - 0x80 - User-defined type.
Changelog
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 1.5.0 | |
| | |
| | Added MongoBinData::GENERIC and MongoB- |
| | inData::UUID_RFC4122 constants. |
| | |
+--------+---------------------------------------------------+
PHP Documentation Group MONGOBINDATA(3)
