Home/ Manual/ bson / binary/ MongoDB\BSON\Binary::__construct

MongoDB\BSON\Binary::__construct

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Construct a new Binary

Description

MongoDB\BSON\Binary::__construct(string $data, int $type = MongoDB\BSON\Binary::TYPE_GENERIC)

data (string): Binary data.
type (int): Unsigned 8-bit integer denoting the data's type. Defaults to MongoDB\BSON\Binary::TYPE_GENERIC if not specified.

Throws MongoDB\Driver\Exception\InvalidArgumentException if type is not an unsigned 8-bit integer.
Throws MongoDB\Driver\Exception\InvalidArgumentException if type is MongoDB\BSON\Binary::TYPE_UUID or MongoDB\BSON\Binary::TYPE_OLD_UUID and data is not exactly 16 bytes in length.

Version	Description
PECL mongodb 1.15.0	The `type` parameter defaults to `MongoDB\BSON\Binary::TYPE_GENERIC` if not specified.
PECL mongodb 1.3.0	`MongoDB\Driver\Exception\InvalidArgumentException` is thrown if `type` is `MongoDB\BSON\Binary::TYPE_UUID` or `MongoDB\BSON\Binary::TYPE_OLD_UUID` and `data` is not exactly 16 bytes in length.
PECL mongodb 1.1.3	`MongoDB\Driver\Exception\InvalidArgumentException` is thrown if `type` is not an unsigned 8-bit integer.

php

<?php

$binary = new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC);
var_dump($binary);

?>

The above example will output:

output

object(MongoDB\BSON\Binary)#1 (2) {
  ["data"]=>
  string(3) "foo"
  ["type"]=>
  int(0)
}