MongoDB\BSON\ObjectID::getTimestamp

Returns the timestamp component of this ObjectID

Description

final public integer MongoDB\BSON\ObjectID::getTimestamp ( void )

The timestamp component of an ObjectID is its first four bytes, which denote the number of seconds since the Unix epoch. This value is read as an unsigned 32-bit integer with big-endian byte order.

Parameters

This function has no parameters.

Return Values

Returns the timestamp component of this ObjectID.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

Examples

Example #1 MongoDB\BSON\ObjectID::getTimestamp example

<?php

var_dump
((new MongoDB\BSON\ObjectId())->getTimestamp());

var_dump((new MongoDB\BSON\ObjectId('0000002a0000000000000000'))->getTimestamp());

?>

The above example will output something similar to:

integer(1484854719)
integer(42)