Class: Struct_DocumentNavigator

Source Location: /package/com/arcadiangarden/ssx/struct/StructDocumentNavigator.inc

Class Overview

PURE_Class
   |
   --Struct_Navigator
      |
      --Struct_DocumentNavigator

Struct_Documentクラスのオブジェクトから生成されるStruct_Navigatorクラスの実装クラスです。

Methods

Inherited Constants

Class: Struct_Navigator

Struct_Navigator::LINK_REL_ALTERNATE
Struct_Navigator::LINK_REL_APPENDIX
Struct_Navigator::LINK_REL_BOOKMARK
Struct_Navigator::LINK_REL_CHAPTER
Struct_Navigator::LINK_REL_CONTENTS
Struct_Navigator::LINK_REL_COPYRIGHT
Struct_Navigator::LINK_REL_EX_FIRST
Struct_Navigator::LINK_REL_EX_LAST
Struct_Navigator::LINK_REL_EX_SELF
Struct_Navigator::LINK_REL_EX_UP
Struct_Navigator::LINK_REL_GLOSSARY
Struct_Navigator::LINK_REL_HELP
Struct_Navigator::LINK_REL_INDEX
Struct_Navigator::LINK_REL_NEXT
Struct_Navigator::LINK_REL_PREV
Struct_Navigator::LINK_REL_SECTION
Struct_Navigator::LINK_REL_START
Struct_Navigator::LINK_REL_STYLESHEET
Struct_Navigator::LINK_REL_SUBSECTION

Inherited Methods

Class: Struct_Navigator

Struct_Navigator::first(): 自分自身と同一階層にあるドキュメントリストの先頭に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。
Struct_Navigator::flushCurrentStructNavigator(): キャッシュされているサイト構造情報を破棄し、次のgetCurrentStructNavigatorメソッド呼び出しが標準の動作に従うように指示します。
Struct_Navigator::getCurrentStructNavigator(): リクエストに従ってサイト構造情報を保持するStruct_Navigatorクラスの実装クラスのインスタンスを作成して返します。
Struct_Navigator::hierarchy(): ナビゲーションの起点となるドキュメントから、親オブジェクトへ可能な限り遡ってリンク情報を保持するStruct_Linkクラスのオブジェクトの配列を返します。
Struct_Navigator::hierarchyHtml(): ヒエラルキーメニューのHTMLを生成して返します。
Struct_Navigator::last(): 自分自身と同一階層にあるドキュメントリストの末尾に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。
Struct_Navigator::links(): ナビゲーションの起点となるドキュメントからの各種ドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトの配列を返します。
Struct_Navigator::next(): 自分自身の直後に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。
Struct_Navigator::prev(): 自分自身の直前に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。
Struct_Navigator::setCurrentStructNavigator(): getCurrentStructNavigatorメソッドで取得されるサイト構造情報を保持するStruct_Navigatorクラスの実装クラスのオブジェクトを設定します。
Struct_Navigator::up(): 親ドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。

Class Details

[line 30]
Struct_Documentクラスのオブジェクトから生成されるStruct_Navigatorクラスの実装クラスです。

ナビゲーションの起点となるドキュメント情報を指定してインスタンスを作成することで、様々な情報を作成することが出来ます。通常Struct_NavigatorクラスのgetCurrentStructNavigatorメソッドはStruct_DocumentNavigatorクラスのインスタンスを返します。

[ Top ]

Class Methods

constructor __construct [line 47]

Struct_DocumentNavigator __construct(
Struct_Document
$document)

コンストラクタです。

ナビゲーションの起点となるドキュメントを指定します。

Tags:

access:

public

Parameters:

Struct_Document

$document

ナビゲーションの起点となるドキュメント

[ Top ]

method first [line 91]

Struct_Link first(
)

自分自身と同一階層にあるドキュメントリストの先頭に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。

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

Tags:

return:	同一階層の先頭ドキュメントへのリンク情報を保持するオブジェクト
access:	public

Overrides Struct_Navigator::first() (自分自身と同一階層にあるドキュメントリストの先頭に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。)

[ Top ]

method getDocument [line 57]

Struct_Document getDocument(
)

ナビゲーションの起点となるドキュメントを取得します。

Tags:

return:	ナビゲーションの起点となるドキュメント
access:	public

[ Top ]

method hierarchy [line 165]

array hierarchy(
)

ナビゲーションの起点となるドキュメントから、親オブジェクトへ可能な限り遡ってリンク情報を保持するStruct_Linkクラスのオブジェクトの配列を返します。

Tags:

return:	ヒエラルキーメニューのリンク情報を保持するStruct_Linkクラスのオブジェクトの配列
access:	public

Overrides Struct_Navigator::hierarchy() (ナビゲーションの起点となるドキュメントから、親オブジェクトへ可能な限り遡ってリンク情報を保持するStruct_Linkクラスのオブジェクトの配列を返します。)

[ Top ]

method last [line 148]

Struct_Link last(
)

自分自身と同一階層にあるドキュメントリストの末尾に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。

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

Tags:

return:	同一階層の末尾ドキュメントへのリンク情報を保持するオブジェクト
access:	public

Overrides Struct_Navigator::last() (自分自身と同一階層にあるドキュメントリストの末尾に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。)

[ Top ]

method next [line 129]

Struct_Link next(
)

自分自身の直後に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。

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

Tags:

return:	直後のドキュメントへのリンク情報を保持するオブジェクト
access:	public

Overrides Struct_Navigator::next() (自分自身の直後に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。)

[ Top ]

method prev [line 110]

Struct_Link prev(
)

自分自身の直前に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。

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

Tags:

return:	直前のドキュメントへのリンク情報を保持するオブジェクト
access:	public

Overrides Struct_Navigator::prev() (自分自身の直前に配置されているドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。)

[ Top ]

method up [line 69]

Struct_Link up(
)

親ドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。

ドキュメントが見付からない場合にはnullを返します。

Tags:

return:	親ドキュメントへのリンク情報を保持するオブジェクト
access:	public

Overrides Struct_Navigator::up() (親ドキュメントへのリンク情報を保持するStruct_Linkクラスのオブジェクトを返します。)

[ Top ]

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