Docs For Class Logbook

constructor __construct [line 36]

Logbook __construct(
)

コンストラクタです。

Tags:

access:

public

[ Top ]

method addYear [line 150]

LogbookYear addYear(
int
$year)

指定の年の更新ログを追加します。

指定の年に既に更新ログが設定されている場合には、既存の更新ログを返します。

Tags:

return:	更新ログの年
access:	public

Parameters:

int

$year

年

[ Top ]

method count [line 46]

int count(
)

登録されている年の個数を取得します。

Tags:

return:	登録されている年の個数
access:	public

[ Top ]

method countOfDay [line 70]

int countOfDay(
)

登録されている日数を取得します。

Tags:

return:	登録されている日数
access:	public

[ Top ]

method countOfItem [line 84]

int countOfItem(
)

登録されている項目の個数を取得します。

Tags:

return:	登録されている項目の個数
access:	public

[ Top ]

method countOfMonth [line 56]

int countOfMonth(
)

登録されている月数を取得します。

Tags:

return:	登録されている月数
access:	public

[ Top ]

method get [line 102]

LogbookYear get(
int
$index)

指定のインデックス番目に登録されている年を返します。

インデックスは0～count()-1の範囲で指定する必要があります。

Tags:

return:	指定のインデックス番目に登録されている年
throws:	EIlligalParameterException インデックスが不正
access:	public

Parameters:

int

$index

インデックス

[ Top ]

method getYear [line 119]

LogbookYear getYear(
int
$year)

指定の年の更新ログを取得します。

指定の年に更新ログが存在しない場合にはfalseを返します。

Tags:

return:	更新ログの年
access:	public

Parameters:

int

$year

年

[ Top ]

method latestDays [line 196]

array latestDays(
int
$maxDays)

最新の日付の更新ログを抽出して返します。

検索結果は$maxDaysで指定した日数以下のLogbookDayオブジェクトの配列です。配列を列挙すれば最新の日付から順番に更新ログが取得されます。

$maxDays引数に0を与えた場合には全ての日付を取得します。

Tags:

return:	LogbookDayオブジェクトの配列
access:	public

Parameters:

int

$maxDays

取得する最大日数

[ Top ]

method load [line 242]

void load(
string
$xmlFileName, [mixed
$tag = null])

更新ログを記述したXMLファイルを読み込みます。

$tag引数には読み込んだ更新情報の更新項目に設定するタグを設定します。設定したタグはsplitByTagメソッドで更新情報のサブセットを作成する際に利用します。

Tags:

access:

public

Parameters:

string	$xmlFileName	取得するXMLファイル
mixed	$tag	タグ

[ Top ]

method splitByTag [line 228]

Logbook splitByTag(
mixed
$tag)

指定のタグが設定された更新項目だけを保持するサブセットを作成して返します。

サブセットは指定のタグを設定された更新項目だけを持つ一覧になります。サブセットが保持する年、月、日の各オブジェクトは新しいインスタンスが作成されますが、更新項目に関しては元セットと同じインスタンスを保持します。

指定のタグが設定された更新項目が存在しない場合には、更新情報を一件も持たない更新情報を返します。

Tags:

return:	サブセット
access:	public

Parameters:

mixed

$tag

タグ

[ Top ]

Class: Logbook

Class Overview

Methods

Class Details

Class Methods

constructor __construct [line 36]

Tags:

method addYear [line 150]

Tags:

Parameters:

method count [line 46]

Tags:

method countOfDay [line 70]

Tags:

method countOfItem [line 84]

Tags:

method countOfMonth [line 56]

Tags:

method get [line 102]

Tags:

Parameters:

method getYear [line 119]

Tags:

Parameters:

method latestDays [line 196]

Tags:

Parameters:

method load [line 242]

Tags:

Parameters:

method splitByTag [line 228]

Tags:

Parameters: