Class TimeEquator

時間オブジェクトの比較を行うための Equator です. このクラスは, 時間オブジェクトをキーとした Peach\Util\HashMap を構築する際に使用してください.

Peach\DT\TimeEquator implements Peach\Util\Equator

Namespace: Peach\DT
Located at Peach/DT/TimeEquator.php

Methods summary
`public`	# `__construct( mixed $fields = null )` 比較対象のフィールドを指定して, 新しい TimeEquator オブジェクトを作成します. 引数の指定方法には以下の方法があります. 比較対象のフィールドを指定して, 新しい TimeEquator オブジェクトを作成します. 引数の指定方法には以下の方法があります. new TimeEquator(); new TimeEquator(array("hour", "minute", "second")); new TimeEquator("date"); new TimeEquator(Time::TYPE_DATE); 引数なしでオブジェクトを生成した場合, このオブジェクトは Time::equals() を使って比較を行います. 通常は, 引数なしのコンストラクタを使う代わりに TimeEquator::getDefault() を使用してください. 引数に比較対象のフィールドを配列で指定した場合, 指定されたフィールドすべてが等しい場合に等価とみなします. 比較対象のフィールドが 1 つだけの場合, そのフィールドを文字列で指定することもできます. また, 以下の定数を使用することもできます. Time::TYPE_DATE Time::TYPE_DATETIME Time::TYPE_TIMESTAMP それぞれ array("year", "month", "date") array("year", "month", "date", "hour", "minute") array("year", "month", "date", "hour", "minute", "second") を指定した場合と同じになります. Parameters `$fields` 比較対象のフィールド一覧
`public static Peach\DT\TimeEquator`	# `getDefault( )` デフォルトの Equator オブジェクトを返します. このオブジェクトは Time::equals() を使って等値性を調べます. デフォルトの Equator オブジェクトを返します. このオブジェクトは Time::equals() を使って等値性を調べます. Returns `Peach\DT\TimeEquator`
`public boolean`	# `equate( Peach\DT\Time $var1, Peach\DT\Time $var2 )` 指定された 2 つの時間オブジェクトが等しいかどうか調べます. この Equator に設定されているフィールドについて比較を行い, 全て等しい場合のみ TRUE を返します. 指定された 2 つの時間オブジェクトが等しいかどうか調べます. この Equator に設定されているフィールドについて比較を行い, 全て等しい場合のみ TRUE を返します. Parameters `$var1` 比較対象の時間オブジェクト `$var2` 比較対象の時間オブジェクト Returns boolean 2 つの時間オブジェクトが等しいと判断された場合のみ TRUE Throws InvalidArgumentException 引数に Time インスタンス以外の値が指定された場合 Implementation of `Peach\Util\Equator::equate()`
`public integer`	# `hashCode( mixed $var )` 年・月・日・時・分・秒の各フィールドからハッシュ値を算出します. 年・月・日・時・分・秒の各フィールドからハッシュ値を算出します. Parameters `$var` Returns integer ハッシュ値 Throws InvalidArgumentException 引数が Time インスタンスでなかった場合 Implementation of `Peach\Util\Equator::hashCode()`