Time\Duration::compare

2 つの期間を比較する

説明

public static int Time\Duration::compare(Time\Duration $a, Time\Duration $b)

期間 a と b を、符号を考慮して比較します。 戻り値は、usort の比較関数が返す値として使えます。

両方のオペランドが Time\Duration オブジェクトの場合、 比較演算子 による大小関係も、このメソッドと同じになります。

パラメータ

a
最初の期間。
b
2 番目の期間。

戻り値

a が b より小さければ 0 より小さな値を、 a が b より大きければ 0 より大きな値を、 両者が等しければ 0 を返します。 返却される値の絶対値に、特に意味はありません。 負の期間は、常に正の期間より小さくなります。

例

例1 Time\Duration::compare の例

<?php
$oneSecond = \Time\Duration::fromSeconds(1);
$oneAndAHalfSeconds = \Time\Duration::fromMilliseconds(1500);
$billionNanoseconds = \Time\Duration::fromNanoseconds(1_000_000_000);

var_dump(\Time\Duration::compare($oneSecond, $oneAndAHalfSeconds) < 0);
var_dump(\Time\Duration::compare($oneAndAHalfSeconds, $oneSecond) > 0);
var_dump(\Time\Duration::compare($oneSecond, $billionNanoseconds) === 0);

// 負の期間は正の期間より小さくなります。
var_dump(\Time\Duration::compare($oneSecond->negate(), $oneSecond) < 0);

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

bool(true)
bool(true)
bool(true)
bool(true)

例2 Time\Duration::compare で期間をソートする

<?php
$durations = [
    \Time\Duration::fromMinutes(2),
    \Time\Duration::fromMilliseconds(250),
    \Time\Duration::fromSeconds(5),
];

usort($durations, \Time\Duration::compare(...));

foreach ($durations as $duration) {
    printf("%d.%09d\n", $duration->seconds, $duration->nanoseconds);
}

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

0.250000000
5.000000000
120.000000000

参考