magic-core

# Class: PathConfigure Source Location: /core/config/PathConfigure.php
### Interface Overview
アプリケーションのクラスパスを解決するインターフェイスです. #### Author(s): T.Okumura #### Version: 1.0.0 | ### Methods getActionPath getActionSuffix getDaoPath getDaoSuffix getDefaultMessageFileName getDtoPath getDtoSuffix getHtmlPath getHtmlSuffix getMessagePath getViewPath getViewSuffix
### Class Details [line 18] アプリケーションのクラスパスを解決するインターフェイスです. アプリケーション側のフォルダ構成を変更する場合は、 このインターフェイスを実装したクラスを作成してください。 #### Tags:
author: | T.Okumura
version: | 1.0.0
[ Top ] ### Class Methods ### method getActionPath [line 41]
`string getActionPath( )`
Actionクラスのフォルダパスを取得します. これは必須です。 デフォルトでは、必然的にアプリケーション側のActionクラスは、 一つのパッケージに集約される事を意味しています。 ただし、実装クラスの記述によっては、 Actionクラスのフォルダ構成を複数にする事も可能でしょう。 必ず最後にDIRECTORY_SEPARATORを含めるようにしてください。 #### Tags:
return: | Actionクラスのフォルダパス
[ Top ] ### method getActionSuffix [line 28]
`string getActionSuffix( )`
Actionクラスのsuffixを取得します. アプリケーション側で共通のsuffixを使用する予定がないのなら、 空文字''を返すように実装してください。 共通のsuffixがなくても、Actionクラスのパスから取得しようと試みます。 #### Tags:
return: | Actionクラスのsuffix
[ Top ] ### method getDaoPath [line 62]
`string getDaoPath( )`
DAOクラスのフォルダパスを取得します. これは必須ではありません。 アプリケーションでDAOクラスを使用しない場合は省略できます。 DAOクラスを使用する場合は、必ず最後にDIRECTORY_SEPARATORを含めるようにしてください。 #### Tags:
return: | DAOクラスのフォルダパス
[ Top ] ### method getDaoSuffix [line 52]
`string getDaoSuffix( )`
DAOクラスのsuffixを取得します. アプリケーションがDAOクラスを使用する際には必須です。 フレームワークはこのsuffixを見て、ActionクラスにDAOクラスをインジェクションします。 統一されたsuffixがなければ、フレームワークがクラスの型を理解できません。 PDOが利用できない環境では、DAOクラスを使用せず、独自の機能を提供する必要があります。 #### Tags:
return: | DAOクラスのsuffix
[ Top ] ### method getDefaultMessageFileName [line 150]
`string getDefaultMessageFileName( )`
デフォルトのメッセージファイル名を取得します. フレームワークでは、ロケールに基づいてファイル名が決定されます。 例えば、ブラウザのロケールが「ja」の場合、ここで指定されたファイル名に、 「_ja」を付加したファイル名を同一ディレクトリで探し、「en」なら「_en」を探します。 いずれのファイルも見つからなければ、ここで取得した名前で探しに行き、 それでもなければexceptionをスローします。 適切なメッセージ出力のためには、アプリケーションは少なくとも一つの メッセージファイルを用意する必要があります。 メッセージファイルの記述方法は、SystemMessageクラスを参考にしてください。 また、メッセージがどのように取得され、使用されているかは、MessageBehaviorクラスを参照してください。 ロケールに関する詳細は、LocaleProviderクラスを参照してください。 #### Tags:
return: | デフォルトのメッセージファイル名
see: | LocaleProvider
see: | MessageBehavior
see: | SystemMessage
[ Top ] ### method getDtoPath [line 82]
`string getDtoPath( )`
DTOクラスのフォルダパスを取得します. これは必須ではありません。 アプリケーションでDTOクラスを使用しない場合は省略できます。 DTOクラスを使用する場合は、必ず最後にDIRECTORY_SEPARATORを含めるようにしてください。 #### Tags:
return: | DTOクラスのフォルダパス
[ Top ] ### method getDtoSuffix [line 72]
`string getDtoSuffix( )`
DTOクラスのsuffixを取得します. アプリケーションがDTOクラスを使用する際には必須です。 フレームワークはこのsuffixを見て、ActionクラスにDAOクラスをインジェクションします。 統一されたsuffixがなければ、フレームワークがクラスの型を理解できません。 #### Tags:
return: | DTOクラスのsuffix
[ Top ] ### method getHtmlPath [line 128]
`string getHtmlPath( )`
HTMLファイルのフォルダパスを取得します. これは必須です。 デフォルトでは、必然的にアプリケーション側のHTMLファイルは、 一つのフォルダに集約される事を意味しています。 ただし、実装クラスのやり方によっては、 HTMLファイルのフォルダ構成を複数にする事も可能でしょう。 必ず最後にDIRECTORY_SEPARATORを含めるようにしてください。 #### Tags:
return: | HTMLファイルのフォルダパス
[ Top ] ### method getHtmlSuffix [line 115]
`string getHtmlSuffix( )`
HTMLファイルのsuffixを取得します. 通常はhtmlを設定しますが、アプリケーションによっては、 htmやshtmlかも知れません。 また、複数の種類を使い分ける必要があるかも知れません。 #### Tags:
return: | HTMLファイルのsuffix
[ Top ] ### method getMessagePath [line 160]
`string getMessagePath( )`
メッセージファイルのフォルダパスを取得します. これは必須ではありません。 アプリケーションでメッセージファイルを使用しない場合は省略できます。 メッセージファイルを使用する場合は、必ず最後にDIRECTORY_SEPARATORを含めるようにしてください。 #### Tags:
return: | メッセージファイルのフォルダパス
[ Top ] ### method getViewPath [line 105]
`string getViewPath( )`
Viewクラスのフォルダパスを取得します. これは必須です。 デフォルトでは、必然的にアプリケーション側のViewクラスは、 一つのパッケージに集約される事を意味しています。 ただし、実装クラスのやり方によっては、 Viewクラスのフォルダ構成を複数にする事も可能でしょう。 必ず最後にDIRECTORY_SEPARATORを含めるようにしてください。 #### Tags:
return: | Viewクラスのフォルダパス
[ Top ] ### method getViewSuffix [line 92]
`string getViewSuffix( )`
Viewクラスのsuffixを取得します. アプリケーション側で共通のsuffixを使用する予定がないのなら、 空文字''を返すように実装してください。 共通のsuffixがなくても、Viewクラスのパスから取得しようと試みます。 #### Tags:
return: | Viewクラスのsuffix
[ Top ] Documentation generated on Fri, 16 Dec 2011 11:13:55 +0100 by phpDocumentor 1.4.3