Time\Duration::multiplyBy

期間を整数倍する

説明

public Time\Duration Time\Duration::multiplyBy(int $factor)

この期間を factor 倍した期間を返します。 符号は維持されます。

パラメータ

factor
乗数。 0 以上でなければなりません。 0 の場合、結果は長さ 0 の期間になります。

戻り値

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

エラー / 例外

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

例

例1 Time\Duration::multiplyBy の例

<?php
var_dump(\Time\Duration::fromMilliseconds(1500)->multiplyBy(4));

try {
    \Time\Duration::fromHours(1)->multiplyBy(3_000_000);
} catch (\Time\TimeException $e) {
    echo $e->getMessage(), PHP_EOL;
}

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

object(Time\Duration)#2 (3) {
  ["seconds"]=>
  int(6)
  ["nanoseconds"]=>
  int(0)
  ["negative"]=>
  bool(false)
}
The maximum representable range is 9_223_372_035 seconds (roughly 292 years)

参考

  • Time\Duration::divideBy
  • Time\Duration::add