Time\Duration::fromIso8601DurationString

ISO 8601 の期間指定から期間を作成する

説明

public static Time\Duration Time\Duration::fromIso8601DurationString(string $specification)

PT1H30M のような » ISO 8601 の期間指定の時間部分から、負でない期間を作成します。

パラメータ

specification
ISO 8601 の期間指定。 書式は、period を表す文字 P で始まり、time を表す文字 T が続きます。さらに、整数値の後に間隔指示子を付けたものを 1 つ以上並べます:
間隔指示子 説明
H 時間
M 分
S 秒
間隔指示子は表の順に並べなければなりませんが、それぞれ省略できます。 値は単位の通常の範囲を超えてもかまわないため、 PT90M と PT1H30M は同じ期間を表します。 年、月、週、日は長さが一定ではないため、日付の間隔指示子 Y、M、W、D は受け付けません。 PT0.5S のような小数の値もサポートしていません。

戻り値

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

エラー / 例外

  • specification を ISO 8601 の期間としてパースできない場合、 Time\TimeException がスローされます。
  • specification に日付の間隔指示子 (Y、M、W、D) が含まれている場合、 Time\TimeException がスローされます。
  • specification が期間ではなく日付/時刻または時間間隔である場合、 Time\TimeException がスローされます。
  • 結果が 期間の最大長 を超える場合、Time\TimeException がスローされます。

例

例1 Time\Duration::fromIso8601DurationString の例

<?php
var_dump(\Time\Duration::fromIso8601DurationString('PT1H30M'));

var_dump(\Time\Duration::fromIso8601DurationString('PT90S')->seconds);

try {
    \Time\Duration::fromIso8601DurationString('P1D');
} catch (\Time\TimeException $e) {
    echo $e->getMessage(), PHP_EOL;
}

try {
    \Time\Duration::fromIso8601DurationString('PT0.5S');
} catch (\Time\TimeException $e) {
    echo $e->getMessage(), PHP_EOL;
}

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

object(Time\Duration)#1 (3) {
  ["seconds"]=>
  int(5400)
  ["nanoseconds"]=>
  int(0)
  ["negative"]=>
  bool(false)
}
int(90)
The ISO 8601 duration string may only contain the time (T) aspect
The ISO 8601 duration string could not be parsed

参考

  • Time\Duration::fromSeconds
  • Time\Duration::fromHours