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

Class: Struct_Directory

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

Class Overview

PURE_Class
   |
   --Struct_DocumentList
      |
      --Struct_Directory

サイト構造化情報のディレクトリ情報を表すクラスです。


Methods


Inherited Methods

Class: Struct_DocumentList

Struct_DocumentList::__construct()
コンストラクタです。
Struct_DocumentList::add()
ドキュメントをドキュメントリストに追加します。
Struct_DocumentList::count()
保持しているドキュメントの数を取得します。
Struct_DocumentList::find()
指定のドキュメントがリストの何番目に格納されているかを検索します。
Struct_DocumentList::get()
指定のインデックス番目のドキュメントを取得します。
Struct_DocumentList::owner()
ドキュメントリストを保持するドキュメントを返します。
Struct_DocumentList::parseDocuments()
サイト構造を保持するXMLファイルの解析結果から、ドキュメントリストを解析します。

Class Details

[line 29]
サイト構造化情報のディレクトリ情報を表すクラスです。

サイト構造化情報のドキュメントリストを表すクラスから派生します。




[ Top ]


Class Methods


constructor __construct [line 66]

Struct_Directory __construct( [string $dirName = "./"], [string $fileName = "directory.xml"])

コンストラクタです。

Struct_Directoryクラスはサイト構造情報を保持するXMLファイルを解析し、指定ディレクトリのサイト構造を構成します。 サイト構造を解析したいディレクトリと、サイト構造の情報を持ったXMLファイル名を指定します。 ディレクトリを省略した場合はカレントディレクトリが解析されます。 XMLファイル名を省略した場合は"directory.xml"が解析されます。 ディレクトリが見付からない場合にはEIlligalParameterException例外が発生します。 サイト構造情報を保持するXMLファイルが見付からない場合、Struct_Directoryクラスはエラーを発生させずにドキュメントをひとつも持たない状態に初期化されます。




Tags:

throws:  EIlligalParameterException ディレクトリが見付からない
access:  public


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

Parameters:

string   $dirName   サイト構造を解析したいディレクトリ名
string   $fileName   サイト構造の情報を持ったXMLファイル名

[ Top ]

method findByFileName [line 180]

Struct_Document findByFileName( string $fileName)

ドキュメントをファイル名を元に検索して、そのオブジェクトを返します。

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




Tags:

return:  見つかったオブジェクト
access:  public


Parameters:

string   $fileName  

[ Top ]

method getDirectory [line 129]

string getDirectory( )

解析したディレクトリ名を取得します。



Tags:

return:  解析したディレクトリ名
access:  public


[ Top ]

method getParentName [line 142]

string getParentName( )

親ディレクトリの親ファイル名を返します。

親ディレクトリの親ファイル名は、ディレクトリ単位での構造で最上位に属するドキュメントリストを保持するドキュメントになります。 物理的な上位ディレクトリを前提に、指定のファイル名となることに注意してください。




Tags:

return:  親ディレクトリの親ファイル名
access:  public


[ Top ]

method owner [line 96]

Struct_Document owner( )

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

ディレクトリを保持するドキュメントは通常、直上のディレクトリに存在し、getParentNameメソッドで取得される名前を持ったドキュメントです。 ディレクトリを保持するドキュメントが存在しない場合、nullを返します。




Tags:

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


Overrides Struct_DocumentList::owner() (ドキュメントリストを保持するドキュメントを返します。)

[ Top ]


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