Docs For Class Struct

Struct_DocumentList __construct(
Struct_Document
$owner)

コンストラクタです。

ドキュメントリストを保持するオーナーとなるドキュメントを指定します。 $owner引数にはStruct_Documentクラスのインスタンスか、nullを指定できますが、通常nullを保持するのはStruct_DocumentListクラスを継承したStruct_Directoryクラスになります。

Tags:

access:

public

Overridden in child classes as:

Struct_Directory::__construct(): コンストラクタです。

Parameters:

Struct_Document

$owner

[ Top ]

Struct_Document add(
)

ドキュメントをドキュメントリストに追加します。

Tags:

return:	追加したドキュメントのインスタンス
access:	public

[ Top ]

int count(
)

保持しているドキュメントの数を取得します。

Tags:

return:	保持しているドキュメントの数
access:	public

[ Top ]

int find(
Struct_Document
$doc)

指定のドキュメントがリストの何番目に格納されているかを検索します。

見つからなかった場合には-1を返します。

Tags:

return:	見つかったインデックス
access:	public

Parameters:

Struct_Document

$doc

検索したいドキュメント

[ Top ]

Struct_Document get(
int
$index)

指定のインデックス番目のドキュメントを取得します。

インデックスは0からcount()-1で指定します。範囲外のインデックスを指定した場合、EIlligalParameterException例外が発生します。

Tags:

return:	指定のインデックス番目のドキュメント
throws:	EIlligalParameterException 範囲外のインデックス
access:	public

Parameters:

int

$index

ドキュメントの位置

[ Top ]

Struct_Document owner(
)

ドキュメントリストを保持するドキュメントを返します。

ドキュメントリストを保持するドキュメントが存在しない場合、nullを返します。

Tags:

return:	ドキュメントリストを保持するドキュメントリスト
access:	public

Overridden in child classes as:

Struct_Directory::owner(): ディレクトリを保持するドキュメントを返します。

[ Top ]

void parseDocuments(

$xml)

サイト構造を保持するXMLファイルの解析結果から、ドキュメントリストを解析します。

$xml引数にはSimpleXMLによりパースされたXMLファイルのオブジェクトから、documentsノードを保持するオブジェクトを指定します。メソッドはdocumentsノードからdocumentノードのリストを取得し、サイト構造にマッピングします。

Tags:

access:

protected

Parameters:

SimpleXMLElement

$xml

ドキュメントリストを保持するSimpleXMLElementオブジェクト

[ Top ]

Class: Struct_DocumentList

Class Overview

Methods

Child classes:

Class Details

Class Methods

constructor __construct [line 51]

Tags:

Parameters:

method add [line 151]

Tags:

method count [line 122]

Tags:

method find [line 166]

Tags:

Parameters:

method get [line 137]

Tags:

Parameters:

method owner [line 112]

Tags:

method parseDocuments [line 72]

Tags:

Parameters: