Home/ Manual/ time / duration/ Time\Duration::sub

Time\Duration::sub

PHP function Edit on GitHub ✎

(PHP 8 >= 8.6.0)

Subtracts a duration

Description

Time\Duration::sub(Time\Duration $duration): Time\Duration

Returns the difference between this duration and duration. The signs of both durations are taken into account, so subtracting a negative duration lengthens a positive one. If duration is longer than this duration, the result is negative.

Parameters

duration: The duration to subtract.

Return Values

Returns a new Time\Duration object.

Errors/Exceptions

Examples

Time\Duration::sub example

php

<?php
var_dump(\Time\Duration::fromSeconds(10)->sub(\Time\Duration::fromMilliseconds(2500)));

// Subtracting a larger duration results in a negative duration.
var_dump(\Time\Duration::fromSeconds(1)->sub(\Time\Duration::fromSeconds(3)));

The above example will output:

output

object(Time\Duration)#3 (3) {
  ["seconds"]=>
  int(7)
  ["nanoseconds"]=>
  int(500000000)
  ["negative"]=>
  bool(false)
}
object(Time\Duration)#1 (3) {
  ["seconds"]=>
  int(2)
  ["nanoseconds"]=>
  int(0)
  ["negative"]=>
  bool(true)
}