Time\Duration::sub

期間を減算する

説明

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

この期間から duration を減算した期間を返します。 どちらの期間の符号も考慮されるため、正の期間から負の期間を減算すると、元の期間より長くなります。 duration がこの期間より大きい場合、結果は負になります。

パラメータ

duration
減算する期間。

戻り値

新しい Time\Duration オブジェクトを返します。

エラー / 例外

  • 結果が 期間の最大長 を超える場合、Time\TimeException がスローされます。

例

例1 Time\Duration::sub の例

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

// より大きな期間を減算すると、負の期間になります。
var_dump(\Time\Duration::fromSeconds(1)->sub(\Time\Duration::fromSeconds(3)));

上の例の出力は以下となります。

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)
}

参考

  • Time\Duration::add
  • Time\Duration::negate
  • Time\Duration::absolute