Docs For Class Struct

constructor __construct [line 75]

Struct_Document __construct(
Struct_DocumentList
$owner)

コンストラクタです。

Tags:

access:

public

Parameters:

Struct_DocumentList

$owner

ドキュメントを保持するドキュメントリスト

[ Top ]

method first [line 225]

Struct_Document first(
)

サイト構造の中で、自分自身と同一階層にあるドキュメントリストの先頭に配置されているドキュメントを検索して返します。

自分自身が先頭ドキュメントだった場合には場合にはnullを返します。

Tags:

return:	同一階層の先頭ドキュメント
access:	public

[ Top ]

method getCaption [line 123]

string getCaption(
)

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

Tags:

return:	キャプション
access:	public

[ Top ]

method getChildList [line 182]

Struct_DocumentList getChildList(
)

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

Tags:

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

[ Top ]

method getDirectory [line 89]

Struct_Directory getDirectory(
)

ドキュメントが格納されているディレクトリを表すオブジェクトを返します。

Tags:

return:	ドキュメントが格納されているディレクトリを表すオブジェクト
access:	public

[ Top ]

method getName [line 103]

string getName(
)

ファイル名を取得します。

Tags:

return:	ファイル名
access:	public

[ Top ]

method getParam [line 149]

mixed getParam(
string
$key, [mixed
$def = false])

ドキュメントに設定されたパラメータを取得します。

パラメータ名は大文字と小文字は区別されないことに注意してください。それは一般的なXMLの文法と異なります。指定のパラメータ名が見付からない場合には$def引数の値が返されます。

Tags:

return:	パラメータ値
access:	public

Parameters:

string	$key	パラメータ名
mixed	$def	パラメータが見付からなかった場合の返却値

[ Top ]

method last [line 279]

Struct_Document last(
)

サイト構造の中で、自分自身と同一階層にあるドキュメントリストの末尾に配置されているドキュメントを検索して返します。

自分自身が末尾ドキュメントだった場合には場合にはnullを返します。

Tags:

return:	同一階層の末尾ドキュメント
access:	public

[ Top ]

method next [line 261]

Struct_Document next(
)

サイト構造の中で、自分自身の直後に配置されているドキュメントを検索して返します。

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

Tags:

return:	直後のドキュメント
access:	public

[ Top ]

method owner [line 192]

Struct_DocumentList owner(
)

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

Tags:

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

[ Top ]

method prev [line 243]

Struct_Document prev(
)

サイト構造の中で、自分自身の直前に配置されているドキュメントを検索して返します。

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

Tags:

return:	直前のドキュメント
access:	public

[ Top ]

method setCaption [line 133]

void setCaption(
string
$caption)

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

Tags:

access:

public

Parameters:

string

$caption

キャプション

[ Top ]

method setName [line 113]

void setName(
string
$name)

ファイル名を設定します。

Tags:

access:

public

Parameters:

string

$name

ファイル名

[ Top ]

method setParam [line 172]

void setParam(
string
$key, mixed
$value)

ドキュメントにパラメータを設定します。

パラメータ名は大文字と小文字は区別されないことに注意してください。それは一般的なXMLの文法と異なります。

パラメータ値は先頭・末尾の空白文字、改行が自動的に削除されます。また改行で区切られた複数行が存在する場合、各行の先頭・末尾の空白文字も自動的に削除されます。また改行文字は "\n" に統一されます。

Tags:

access:

public

Parameters:

string	$key	パラメータ名
mixed	$value	パラメータ値

[ Top ]

method up [line 210]

Struct_Document up(
)

サイト構造の中で親のドキュメントを検索して返します。

親のドキュメントは必ずしも親ディレクトリに存在するとは限りません。サイト構造を記述するXMLは同一のディレクトリ内であってもドキュメントの上下関係を記述することが出来ます。同一のディレクトリに属しているか否かはupメソッドにより得られたドキュメントと自分自身のドキュメントの双方から得られるgetDirectoryメソッドの返り値を比較します。 getDirectoryメソッドの返り値が等しい場合には、親ドキュメントは同一のディレクトリ内に存在します。 getDirectoryメソッドの返り値が等しくない場合には、親ドキュメントは親ディレクトリ内に存在します。

親ドキュメントが見つからなかった場合にはnullを返します。

Tags:

return:	親ドキュメント
access:	public

[ Top ]

Class: Struct_Document

Class Overview

Methods

Class Details

Class Methods

constructor __construct [line 75]

Tags:

Parameters:

method first [line 225]

Tags:

method getCaption [line 123]

Tags:

method getChildList [line 182]

Tags:

method getDirectory [line 89]

Tags:

method getName [line 103]

Tags:

method getParam [line 149]

Tags:

Parameters:

method last [line 279]

Tags:

method next [line 261]

Tags:

method owner [line 192]

Tags:

method prev [line 243]

Tags:

method setCaption [line 133]

Tags:

Parameters:

method setName [line 113]

Tags:

Parameters:

method setParam [line 172]

Tags:

Parameters:

method up [line 210]

Tags: