DT

クラス: Peach_DT_TimeEquator

定義: /Peach/DT/TimeEquator.php

時間オブジェクトの比較を行うための Equator です.

このクラスは, 時間オブジェクトをキーとした HashMap を構築する際に使用してください.

すべての実装されたインタフェース

メソッド

メソッド 詳細

static getDefault

line 116

static Peach_DT_TimeEquator getDefault()

デフォルトの Peach_DT_Equator オブジェクトを返します.

このオブジェクトは Peach_DT_Time::equals() を使って等値性を調べます.

Tags

  • access : public

constructor __construct

line 79

Peach_DT_TimeEquator __construct([mixed $fields = null])

比較対象のフィールドを指定して, 新しい Peach_DT_TimeEquator オブジェクトを作成します.

引数の指定方法には以下の方法があります.

  1.  new Peach_DT_TimeEquator(array("hour""minute""second"));
  2.  new Peach_DT_TimeEquator("date");

引数なしでオブジェクトを生成した場合, このオブジェクトは Peach_DT_Time::equals() を使って比較を行います. 通常は, 引数なしのコンストラクタを使う代わりに Peach_DT_TimeEquator::getDefault() を使用してください.

引数に比較対象のフィールドを配列で指定した場合, 指定されたフィールドすべてが等しい場合に等価とみなします.

比較対象のフィールドが 1 つだけの場合, そのフィールドを文字列で指定することもできます.

また, 以下の定数を使用することもできます.

それぞれ

  • array("year", "month", "date")
  • array("year", "month", "date", "hour", "minute")
  • array("year", "month", "date", "hour", "minute", "second")

を指定した場合と同じになります.

Tags

  • access : public

引数

mixed   $fields   比較対象のフィールド一覧

equate

line 135

bool equate(Peach_DT_Time $var1, Peach_DT_Time $var2)

指定された 2 つの時間オブジェクトが等しいかどうか調べます.

この Equator に設定されているフィールドについて比較を行い, 全て等しい場合のみ TRUE を返します.

Tags

  • return : 2 つの時間オブジェクトが等しいと判断された場合のみ TRUE
  • throws : InvalidArgumentException 引数に Peach_DT_Time インスタンス以外の値が指定された場合
  • access : public

引数

Peach_DT_Time   $var1   比較対象の時間オブジェクト
Peach_DT_Time   $var2   比較対象の時間オブジェクト

hashCode

line 163

int hashCode(mixed $var)

年・月・日・時・分・秒の各フィールドからハッシュ値を算出します.

Tags

  • return : ハッシュ値
  • throws : Exception 引数が Peach_DT_Time インスタンスでなかった場合
  • access : public

引数

mixed   $var