ルーター系の関数
目次
- モジュールの有無判定 : is_module() ― モジュールの有無を確認します
- モジュールURIを取得 : module_uri() ― モジュールURIを取得します
- アクションURIを取得 : action_uri() ― アクションURIを取得します
- メインURIを取得 : main_uri() ― 初回のアクションURIを取得します
モジュールの有無判定
is_module($uri)
モジュールの有無を判定します。
LPVワークフローに沿った、ロジッククラス、プレップクラス、またはビューテンプレートのいづれかが存在する場合は「TRUE」を返します。
戻り値
型 : boolean
「TRUE」の場合、モジュールが存在することなります。
引数値
項目 | 型 | 内容 |
---|---|---|
$uri | string | モジュールURIを指定します |
モジュールURIを取得
module_uri($main = FALSE)
モジュールURIを取得します。
モジュールURIとは、URIから引数として扱われている情報を排除した部分です。
例) URIが item/detail/29
の場合、item/detail
が取得できます。
戻り値
型 : string
引数値
項目 | 型 | 内容 |
---|---|---|
$main | boolean | メインモジュール(初回実行のモジュール)の取得フラグを指定します |
$main
値に「TRUE」を指定すると、invoke()
関数で複数のモジュールをチェーン実行している場合においても、初回のモジュール名を取得することができます。
アクションURIを取得
action_uri($main = FALSE)
アクションURIを取得します。
アクションURIとは、URIの引数として扱われている情報を含む全ての部分です。
例) URIが item/detail/29
の場合、item/detail/29
が取得できます。
戻り値
型 : string
引数値
項目 | 型 | 内容 |
---|---|---|
$main | boolean | メインモジュール(初回実行のモジュール)の取得フラグを指定します |
$main
値に「TRUE」を指定すると、invoke()
関数で複数のモジュールをチェーン実行している場合においても、初回のモジュール名を取得することができます。
メインアクションURIを取得
main_uri()
メインアクションURIを取得します。
action_uri(TRUE)
と同様の動作になります。
例) URIが item/detail/29
の場合、item/detail/29
が取得できます。
戻り値
型 : string
引数値
なし