ルーティング
Fuel では、単純な静的なルート設定から HTTP の動詞によるルーティングを用いた高度なルート設定に至るまで、様々なルーティングが可能です。
ルート設定は、fuel/app/config/routes.php で行います。
予約済みルート
Fuel には 2 つの予約済みルートがあります。_root_ および _404_ です。
- _root_ - URI が指定されていないときのデフォルトルート。
- _404_ - コントローラ、あるいはアクションが見つからないときのルート。 キャッチオールのルートとしても使えます。
return array(
'_root_' => 'welcome/index',
'_404_' => 'welcome/404',
);
基本的なルーティング
左辺に記述されたルートは、リクエストされた URI と比較されます。もしマッチしていれば、そのリクエストは右辺の URI に経路づけられます。
このルーティングによって、次のようなことが可能になります。:
return array(
'about' => 'site/about',
'contact' => 'contact/form',
'admin' => 'admin/login',
);
やや高度なルーティング
ルート設定には正規表現を含めることが出来ます。 左辺とリクエストされた URI がマッチしたら、そのマッチした部分を右辺に代入するといったような、 左辺の正規表現による右辺の後方参照が利用可能です。また、次のようないくつかの特別な宣言があり、それを用いて何かにマッチさせたり、 あるいは特定セグメントにマッチさせたりすることが出来ます。
- :any - URI の任意の部分にマッチする
- :segment - URI の 1 つのセグメントのみにマッチする。しかしそのセグメントは任意のものであっていい。
- :num - 何らかの数値にマッチする。
- :alpha - 何らかのアルファベットにマッチする。UTF-8 を含みます。
- :alnum - 何らかのアルファベットと数字にマッチする。 UTF-8 を含みます。
いくつかの例:
return array(
'blog/(:any)' => 'blog/entry/$1', // /blog/entry_name が /blog/entry/entry_name に経路付けられる
'(:segment)/about' => 'site/about/$1', // /en/about が /site/about/en に経路付けられる
'(\d{2})/about' => 'site/about/$1', // /12/about が /site/about/12 に経路付けられる
);
高度なルーティング
ルート設定では、名前付きパラメータを使えます。これより、URI セグメントに対して名前を与えることができ、 アクションメソッドの中でアクセスできます。
例:
return array(
'blog/:year/:month/:id' => 'blog/entry', // /blog/2010/11/entry_name が /blog/entry に経路付けられる
);
上の例では、/blog/2010/11/entry_name が捕捉され、 'blog' コントローラ内の 'entry' アクションにルーティングされます。 そこでは、下記のような名前付きパラメータを使うことができます。:
$this->param('year');
$this->param('month');
$this->param('id');
Note that as a named parameter is a regex, every named parameter counts as a backreference. So in a route like ':name/(\d{2})', the backreference for your two-digit segment is $2, not $1!
HTTP の動詞によるルーティング
アクセスされた HTTP の動詞に基づいて、URL をコントローラとアクションに経路付けることができます。 このことによって、素早く簡単に RESTful なコントローラを作成できます。
例:
return array(
// GET /blog が /blog/allに、POST /blog が /blog/create に経路付けられる
'blog' => array(array('GET', new Route('blog/all')), array('POST', new Route('blog/create'))),
);
URL には、名前付きパラメータと正規表現を普通に使えます:
return array(
'blog/(:any)' => array(array('GET', new Route('blog/show/$1'))),
);
名前付きルートとリバースルーティング
リバースルーティングというのは、次のような考え方を指します。たとえば管理エリアを作ろうとし、そのルートをセットアップします。 ビューにおいて、管理エリアで例えば 'admin/start/overview' という HTML アンカーを使いたいとしましょう。 ところが、気が変わって、そのページを 'admin/overview' という風に変えることにします。 その結果、全てのビューで、そのリンクを更新しなければならなくなってしまいました...
名前付きルートとリバースルーティングを用いると、名前付きルートをアンカーリンクにすることができ、 ルートが変わっても、各ビューの中でのリンクはその変更を自動的に追随します。
ルートの例:
return array(
'admin/start/overview' => array('admin/overview', 'name' => 'admin_overview'), // admin/overview ページに対して名前付きルート名を追加する
);
アンカーの例:
// <a href="http://your_base_url/admin/start/overview">Overview</a> を生成する
echo Html::anchor(Router::get('admin_overview'), 'Overview');
Note that this currently only works for routes that are defined in app/config/routes.php, not for module routes.
Inline routes
A route does not have to resolve to a controller method. FuelPHP also supports inline routes, which are defined as a Closure that replaces the controller method. Like controller methods, inline routes MUST return a Response object, either by forging one manually, or as the result of executing a forged Request.
Example route:
return array(
'secret/mystuff' => function () {
// this route only works in development
if (\Fuel::$env == \Fuel::DEVELOPMENT)
{
return \Request::forge('secret/mystuff/keepout', false)->execute();
}
else
{
throw new HttpNotFoundException('This page is only accessable in development.');
}
};