MongoDB\BSON\ObjectId::__construct

Construct a new ObjectId

Description

final public MongoDB\BSON\ObjectId::__construct(stringnull $id = null)

Parameters

id (string)

A 24-character hexadecimal string. If not provided, the extension will generate an ObjectId.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
  • Throws MongoDB\Driver\Exception\InvalidArgumentException if id is not a 24-character hexadecimal string.

Examples

Example #1 MongoDB\BSON\ObjectId::__construct example

<?php

var_dump(new MongoDB\BSON\ObjectId());

var_dump(new MongoDB\BSON\ObjectId('000000000000000000000001'));

?>

The above example will output something similar to:

object(MongoDB\BSON\ObjectId)#1 (1) {
  ["oid"]=>
  string(24) "56732d3dda14d81214634921"
}
object(MongoDB\BSON\ObjectId)#1 (1) {
  ["oid"]=>
  string(24) "000000000000000000000001"
}