DT

クラス: Peach_DT_AbstractTime

定義: /Peach/DT/AbstractTime.php

時間を表す抽象基底クラスです.

Peach_DT_Date, Peach_DT_Datetime, Peach_DT_Timestamp の共通部分の実装です.

Tags

  • abstract

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

メソッド

直系の既知のサブクラス

Peach_DT_Date
DATE 型の時間オブジェクトです.

メソッド 詳細

add

line 141

Peach_DT_Time add(string $field, int $amount)

引数のフィールドを, $amount だけ増加 (負の場合は減少) させます.

Tags

  • return : 設定後の時間オブジェクト
  • access : public

引数

string   $field   対象のフィールド
int   $amount   加算する量. マイナスの場合は過去方向に移動する.

定義

Peach_DT_Time::add()
引数のフィールドを, $amount だけ増加 (負の場合は減少) させます.

after

line 228

bool after(Peach_DT_Time $time)

指定された時間とこの時間を比較します.

もしもこのオブジェクトが持つ時間フィールドすべてが 引数のオブジェクトの時間フィールドと一致した場合, より多くの時間フィールドを持つほうが「後」となります.

例: 2012-05-21 (Peach_DT_Date) < 2012-05-21T00:00 (Peach_DT_Datetime) < 2012-05-21T00:00:00 (Peach_DT_Timestamp)

Tags

  • return : この時間のほうが未来である場合は TRUE, それ以外は FALSE
  • access : public

引数

Peach_DT_Time   $time   比較対象の時間

定義

Peach_DT_Time::after()
指定された時間とこの時間を比較します.

before

line 210

bool before(Peach_DT_Time $time)

指定された時間とこの時間を比較します.

もしもこのオブジェクトが持つ時間フィールドすべてが 引数のオブジェクトの時間フィールドと一致した場合, より多くの時間フィールドを持つほうが「後」となります.

例: 2012-05-21 (Peach_DT_Date) < 2012-05-21T00:00 (Peach_DT_Datetime) < 2012-05-21T00:00:00 (Peach_DT_Timestamp)

Tags

  • return : この時間のほうが過去である場合は TRUE, それ以外は FALSE
  • access : public

引数

Peach_DT_Time   $time   比較対象の時間

定義

Peach_DT_Time::before()
指定された時間とこの時間を比較します.

compareTo

line 162

int compareTo(mixed $obj)

この時間と指定された時間を比較します.

このメソッドは, 自身と引数の時間オブジェクトが共通で持っているフィールドについて比較を行います. 比較の結果すべてのフィールドの値が等しかった場合, より多くの時間フィールドを持つほうが「後」となります.

例: 2012-05-21 (Peach_DT_Date) < 2012-05-21T00:00 (Peach_DT_Datetime) < 2012-05-21T00:00:00 (Peach_DT_Timestamp)

Tags

  • return : この時間のほうが過去の場合は負の値, 未来の場合は正の値, 等しい場合は 0. ただし, 引数が時間オブジェクトでない場合は NULL
  • access : public

引数

mixed   $obj   比較対象のオブジェクト

定義

Peach_Util_Comparable::compareTo()
このオブジェクトと引数の値を比較します.

equals

line 190

bool equals(mixed $obj)

指定されたオブジェクトとこのオブジェクトを比較します.

compareTo による比較結果が 0 を返し, かつクラスが同じ場合に TRUE を返します.

Tags

  • return : 二つのオブジェクトが等しい場合に TRUE, それ以外は FALSE
  • access : public

引数

mixed   $obj   比較対象のオブジェクト

定義

Peach_DT_Time::equals()
指定されたオブジェクトとこのオブジェクトを比較します.

format

line 178

string format([Peach_DT_Format $format = null])

指定されたフォーマットを使ってこの時間オブジェクトを書式化します.

フォーマットを指定しない場合はデフォルトの方法 (SQL などで使われる慣用表現) で書式化を行ないます.

Tags

  • access : public

引数

Peach_DT_Format   $format  

定義

Peach_DT_Time::format()
指定されたフォーマットを使ってこの時間オブジェクトを書式化します.

formatTime

line 240

string formatTime()

この時間の時刻 (時・分・秒) 部分を書式化します.

時・分・秒をサポートしていないオブジェクトの場合は空文字列を返します.

Tags

  • return : "hh:mm:ss" 形式の文字列. このオブジェクトが時刻をサポートしない場合は空文字列.
  • access : public

定義

Peach_DT_Time::formatTime()
この時間の時刻 (時・分・秒) 部分を書式化します.

get

line 88

int get(string $field)

指定されたフィールドの値を取得します.

Tags

  • return : 対象フィールドの値. ただしフィールド名が不正な場合は NULL
  • access : public

引数

string   $field   フィールド名

定義

Peach_DT_Time::get()
指定されたフィールドの値を取得します.

set

line 101

Peach_DT_Time set(string $field, int $value)

この時間オブジェクトの指定されたフィールドを上書きします.

Tags

  • return : 設定後の時間オブジェクト
  • access : public

引数

string   $field   フィールド名
int   $value   設定する値

定義

Peach_DT_Time::set()
この時間オブジェクトの指定されたフィールドを上書きします.

setAll

line 118

Peach_DT_Time setAll(Peach_Util_Map|array $subject)

この時間オブジェクトの複数のフィールドを一度に上書きします.

引数には,

  1. array("year" => 2010"month" => 8"date" => 31)

などの配列か, または同様の Map オブジェクトを指定してください.

Tags

  • return : 設定後の時間オブジェクト
  • access : public

引数

Peach_Util_Map|array   $subject   フィールドと値の一覧

定義

Peach_DT_Time::setAll()
この時間オブジェクトの複数のフィールドを一度に上書きします.

__toString

line 251

string __toString()

このオブジェクトが指す時刻を, SQL などで使われる慣用表現に変換して返します.

Tags

  • return : このオブジェクトの文字列表現 ("YYYY-MM-DD", "YYYY-MM-DD hh:mm" など)
  • access : public