Class AbstractTime

時間を表す抽象基底クラスです. Peach\DT\Date, Peach\DT\Datetime, Peach\DT\Timestamp の共通部分の実装です.

Peach\DT\AbstractTime implements Peach\DT\Time

Direct known subclasses

Indirect known subclasses

Peach\DT\Datetime, Peach\DT\Timestamp

Abstract
Namespace: Peach\DT
Located at Peach/DT/AbstractTime.php

Methods summary
`final public integer`	# `get( string $field )` 指定されたフィールドの値を取得します. 指定されたフィールドの値を取得します. Parameters `$field` フィールド名 Returns integer 対象フィールドの値. ただしフィールド名が不正な場合は NULL Implementation of `Peach\DT\Time::get()`
`final public Peach\DT\Time`	# `set( string $field, integer $value )` この時間オブジェクトの指定されたフィールドを上書きします. この時間オブジェクトの指定されたフィールドを上書きします. Parameters `$field` フィールド名 `$value` 設定する値 Returns `Peach\DT\Time` 設定後の時間オブジェクト Implementation of `Peach\DT\Time::set()`
`final public Peach\DT\Time`	# `setAll( Peach\Util\Map\|array $subject )` この時間オブジェクトの複数のフィールドを一度に上書きします. 引数には, array("year" => 2010, "month" => 8, "date" => 31) などの配列か, または同様の Map オブジェクトを指定してください. この時間オブジェクトの複数のフィールドを一度に上書きします. 引数には, array("year" => 2010, "month" => 8, "date" => 31) などの配列か, または同様の Map オブジェクトを指定してください. Parameters `$subject` フィールドと値の一覧 Returns `Peach\DT\Time` 設定後の時間オブジェクト Throws InvalidArgumentException 引数の型が不正な場合 Implementation of `Peach\DT\Time::setAll()`
`final public Peach\DT\Time`	# `add( string $field, integer $amount )` 引数のフィールドを, $amount だけ増加 (負の場合は減少) させます. 引数のフィールドを, $amount だけ増加 (負の場合は減少) させます. Parameters `$field` 対象のフィールド `$amount` 加算する量. マイナスの場合は過去方向に移動する. Returns `Peach\DT\Time` 設定後の時間オブジェクト Implementation of `Peach\DT\Time::add()`
`final public integer`	# `compareTo( mixed $obj )` この時間と指定された時間を比較します. このメソッドは, 自身と引数の時間オブジェクトが共通で持っているフィールドについて比較を行います. 比較の結果すべてのフィールドの値が等しかった場合, より多くの時間フィールドを持つほうが「後」となります. この時間と指定された時間を比較します. このメソッドは, 自身と引数の時間オブジェクトが共通で持っているフィールドについて比較を行います. 比較の結果すべてのフィールドの値が等しかった場合, より多くの時間フィールドを持つほうが「後」となります. 例: 2012-05-21 (Date) < 2012-05-21T00:00 (Datetime) < 2012-05-21T00:00:00 (Timestamp) Parameters `$obj` 比較対象のオブジェクト Returns integer この時間のほうが過去の場合は負の値, 未来の場合は正の値, 等しい場合は 0. ただし, 引数が時間オブジェクトでない場合は NULL Implementation of `Peach\Util\Comparable::compareTo()`
`final public string`	# `format( Peach\DT\Format $format = null )` 指定されたフォーマットを使ってこの時間オブジェクトを書式化します. フォーマットを指定しない場合はデフォルトの方法 (SQL などで使われる慣用表現) で書式化を行ないます. 指定されたフォーマットを使ってこの時間オブジェクトを書式化します. フォーマットを指定しない場合はデフォルトの方法 (SQL などで使われる慣用表現) で書式化を行ないます. Parameters `$format` Returns string 時間オブジェクトの文字列表現 (例: "YYYY-MM-DD" など) Implementation of `Peach\DT\Time::format()`
`public boolean`	# `equals( mixed $obj )` 指定されたオブジェクトとこのオブジェクトを比較します. compareTo による比較結果が 0 を返し, かつクラスが同じ場合に TRUE を返します. 指定されたオブジェクトとこのオブジェクトを比較します. compareTo による比較結果が 0 を返し, かつクラスが同じ場合に TRUE を返します. Parameters `$obj` 比較対象のオブジェクト Returns boolean 二つのオブジェクトが等しい場合に TRUE, それ以外は FALSE Implementation of `Peach\DT\Time::equals()`
`final public boolean`	# `before( Peach\DT\Time $time )` 指定された時間とこの時間を比較します. 指定された時間とこの時間を比較します. もしもこのオブジェクトが持つ時間フィールドすべてが引数のオブジェクトの時間フィールドと一致した場合, より多くの時間フィールドを持つほうが「後」となります. 例: 2012-05-21 (Date) < 2012-05-21T00:00 (Datetime) < 2012-05-21T00:00:00 (Timestamp) Parameters `$time` 比較対象の時間 Returns boolean この時間のほうが過去である場合は TRUE, それ以外は FALSE Implementation of `Peach\DT\Time::before()`
`final public boolean`	# `after( Peach\DT\Time $time )` 指定された時間とこの時間を比較します. 指定された時間とこの時間を比較します. もしもこのオブジェクトが持つ時間フィールドすべてが引数のオブジェクトの時間フィールドと一致した場合, より多くの時間フィールドを持つほうが「後」となります. 例: 2012-05-21 (Date) < 2012-05-21T00:00 (Datetime) < 2012-05-21T00:00:00 (Timestamp) Parameters `$time` 比較対象の時間 Returns boolean この時間のほうが未来である場合は TRUE, それ以外は FALSE Implementation of `Peach\DT\Time::after()`
`public string`	# `formatTime( )` この時間の時刻 (時・分・秒) 部分を書式化します. 時・分・秒をサポートしていないオブジェクトの場合は空文字列を返します. この時間の時刻 (時・分・秒) 部分を書式化します. 時・分・秒をサポートしていないオブジェクトの場合は空文字列を返します. Returns string "hh:mm:ss" 形式の文字列. このオブジェクトが時刻をサポートしない場合は空文字列. Implementation of `Peach\DT\Time::formatTime()`
`public string`	# `__toString( )` このオブジェクトが指す時刻を, SQL などで使われる慣用表現に変換して返します. このオブジェクトが指す時刻を, SQL などで使われる慣用表現に変換して返します. Returns string このオブジェクトの文字列表現 ("YYYY-MM-DD", "YYYY-MM-DD hh:mm" など) Codecoverageignore

Methods inherited from Peach\DT\Time
`getDateCount(), getDay(), getType(), isLeapYear(), toDate(), toDatetime(), toTimestamp()`

Constants inherited from Peach\DT\Time
`FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, TYPE_DATE, TYPE_DATETIME, TYPE_TIMESTAMP, WEDNESDAY`