com.arcadiangarden.ssx.logbook
[ class tree: com.arcadiangarden.ssx.logbook ] [ index: com.arcadiangarden.ssx.logbook ] [ all elements ]

Class: LogbookItem

Source Location: /package/com/arcadiangarden/ssx/logbook/LogbookItem.inc

Class Overview

PURE_Class
   |
   --LogbookItem

更新ログの項目を管理するクラスです。


Methods



Class Details

[line 19]
更新ログの項目を管理するクラスです。



[ Top ]


Class Methods


constructor __construct [line 63]

LogbookItem __construct( LogbookDay $owner, [string $caption = ""], [string $description = ""])

コンストラクタです。



Tags:

access:  public


Parameters:

LogbookDay   $owner   項目を保持する更新ログの日
string   $caption   項目のキャプション
string   $description   項目の説明

[ Top ]

method addRelated [line 177]

LogbookRelated addRelated( [string $url = ""], [string $caption = ""])

項目に関連するリソースを追加します。



Tags:

return:  追加された関連するリソース
access:  public


Parameters:

string   $url   関連するリソースのアドレス
string   $caption   関連するリソースの名前

[ Top ]

method count [line 147]

int count( )

登録されている関連するリソースの個数を取得します。



Tags:

return:  登録されている関連するリソースの個数
access:  public


[ Top ]

method get [line 161]

LogbookRelated get( int $index)

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

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




Tags:

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


Parameters:

int   $index   インデックス

[ Top ]

method getCaption [line 87]

string getCaption( )

項目のキャプションを取得します。



Tags:

return:  項目のキャプション
access:  public


[ Top ]

method getDescription [line 107]

string getDescription( )

項目の説明を取得します。



Tags:

return:  項目の説明
access:  public


[ Top ]

method getTag [line 127]

mixed getTag( )

タグを取得します。



Tags:

return:  タグ
access:  public


[ Top ]

method owner [line 77]

LogbookDay owner( )

項目を保持する更新ログの日を取得します。



Tags:

return:  項目を保持する更新ログの日
access:  public


[ Top ]

method setCaption [line 97]

void setCaption( string $caption)

項目のキャプションを設定します。



Tags:

access:  public


Parameters:

string   $caption   項目のキャプション

[ Top ]

method setDescription [line 117]

void setDescription( string $description)

項目の説明を設定します。



Tags:

access:  public


Parameters:

string   $description   項目の説明

[ Top ]

method setTag [line 137]

void setTag( mixed $tag)

タグを設定します。



Tags:

access:  public


Parameters:

mixed   $tag   タグ

[ Top ]


Documentation generated on Sun, 06 Jan 2008 01:33:16 +0900 by phpDocumentor 1.3.2