MongoDB\BSON\Timestamp
PHP Manual

MongoDB\BSON\Timestamp::getIncrement

Returns the increment component of this Timestamp

Description

final public int MongoDB\BSON\Timestamp::getIncrement()

The increment component of a Timestamp is its least significant 32 bits, whichs denotes the incrementing ordinal for operations within a given second. This value is read as an unsigned 32-bit integer with big-endian byte order.

Note: Because PHP's integer type is signed, some values returned by this method may appear as negative integers on 32-bit platforms. The "%u" formatter of sprintf may be used to obtain a string representation of the unsigned decimal value.

Parameters

This function has no parameters.

Return Values

Returns the increment component of this Timestamp.

Warning

On 32-bit systems this method may return a negative number. Although the increment and timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can not represent these on 32-bit platforms.

Errors/Exceptions

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