ルーティング

ルーティングはURLをどのコントローラーのアクションと関連付けてマッピングするか決める機能です。 これはCakePHP でURLをより細かく柔軟に設定できるようにするために作られました。 Apache の mod_rewrite はルーティングのために必要でないです。しかし、これはアドレスバーを綺麗に見せます。

CakePHP でのルーティングはまた 配列による引数を文字列によるURLに変換するリバースルーティングも含みます。 リバースルーティングによって、簡単にアプリのURLの構造を全部のコードの書き直しをせずにリファクタリングできます。

ルーティングの設定

ルーティングの設定は app/Config/routes.php でできます。 このファイルは必要なルートを制御し特定のルートを指定することを許可するときに Dispatcher によってインクルードされます。 リクエストが一致した時にこのファイルの中で宣言されているルートが最初から最後まで生成されます。 この意味はルーティングの設定はどのようにルートがパースされるかにちて影響を与えるということです。 これは頻繁アクセスするトップのルートファイルにアクセス可能な場合にルーティング(URLを切り替える)する一般的に良いアイディアです。 リクエストと一致しないたくさんのルートをチェックする必要性をなくします。

ルートは接続先に合わせてパースされ一致させられます。 2つの似たルートを定義する場合、最初に定義されたルートがあとに定義されたものより優先されます。 接続後ルーティングを Router::promote() で設定できます。

CakePHP はまた、開発を簡単に始めるためのいくつかのデフォルトルーティングがあります。 これらは、後でそれが必要になったときに無効化できます。無効化する方法は、 デフォルトルーティングの無効化 です。

デフォルトルーティング

自分のルーティングを設定する方法を知る前に、 CakePHP がデフォルトの設定をされていることを知るべきです。 CakePHP のデフォルトルーティングはほかのアプリに比べてとても進んでいます。 一つのアクションに対して直接URLにアクション名を書くことでアクセスできます。 アクションに対してURLを使って引数も渡すことができます。

// デフォルトルートの URL パターン:
http://example.com/controller/action/param1/param2/param3

/posts/view は PostsController の view() アクションに接続することを示しています。 それと、 /products/view_clearance は ProductsController の view_clearance() アクションを示しています。 指定したアドレスにアクションがない場合、 index() を読んでいると推定されます。

デフォルトルーティングの設定は引数をURLを使って渡すことを許可します。 /posts/view/25 へのリクエストは、 PostsController の view(25) を呼ぶのと同じです。 たとえば、デフォルトのルーティングはプラグインへのルーティングも提供します。 そのために、プレフィックスを使うプラグインや機能に合わせて選択します。

あらかじめ用意されているルーティングの設定は、 Cake/Config/routes.php にあります。 デフォルト設定を routes.php を削除することによって無効化できます。

ルーティングによる接続

ルーティングを設定することで、与えられたURLに対してどのようにアプリが反応するのか決められます。 app/Config/routes.php でルーティングを Router::connect() メソッドを使って設定できます。

connect() メソッドは3つの引数をとります。それは、ルーティングするURL、ルーティングする対象のデフォルトの値、 正規表現でどのURLの構成要素と何の条件が一致するかを表現します。

基本のフォーマットは以下です。

Router::connect(
    'URL',
    array('default' => 'defaultValue'),
    array('option' => 'matchingRegex')
);

1番目の引数は、ルーターにどのURLを制御しようとしているのか伝えます。 このURLは普通のスラッシュで区切られた文字列ですが、ワイルドカード (*) や ルーティングのための要素 を含むことができます。 ワイルドカードは、すべての引数を受け付けることを意味します。 * なしだと、文字列に完全一致するものだけに絞られます。

URLが特定されたら、一致したときに同様な動作をするかを connect() の残り二つの引数を使います。 2番目の引数は、連想配列です。この配列の添え字は、 URLのルーティング要素に合わせるか、 デフォルト要素である、 :controller, :action:plugin とつけられます。 配列の値はキーのためのデフォルトの値になります。3番目の引数を使う前に基本的な例を見ましょう。

Router::connect(
    '/pages/*',
    array('controller' => 'pages', 'action' => 'display')
);

CakePHP によってあらかじめ作られている routes.php ファイルでこのルーティングは見つけられます。 このルートは /pages/ ではじまるすべてのURLに一致し、それを PagesController();display() アクションに渡します。 この場合、 /pages/products へのリクエストは、 PagesController->display('products') に送られます。.

/* に加えて、 /** という構文もあります。 末尾に重ねて星を使うことで、 URL の残りを一つの引数として取ることができます。 これは、 / を含む引数を使いたい時に便利です。

Router::connect(
    '/pages/**',
    array('controller' => 'pages', 'action' => 'show')
);

/pages/the-example-/-and-proof がURLとして渡ってきたときに、 the-example-/-and-proof を引数として渡せます。

バージョン 2.1 で追加: 2.1 で /** は追加されました。

Router::connect() の第二引数は、当該のルートの初期値からなる 任意のルーティングパラメーターを与えるために使えます。

Router::connect(
    '/government',
    array('controller' => 'pages', 'action' => 'display', 5)
);

この例では、 connect() の第2引き数をデフォルトの値を定義するために使う方法を示しています。 もし、いろいろなカテゴリの製品を顧客に対して提供するサイトを作るのであれば、ルーティングすることを考えるべきです。 この例では、 /pages/display/5 にアクセスするために /government がURLとして使えます。

注釈

デフォルトルートが動かしたままで、別のルートからも接続できます。 これは、2つのURLからコンテンツをたどることができるようにします。 デフォルトルーティングの無効化 はデフォルトルーティングを無効化し 自分で定義したURLのみを使用する方法です。

ほかの一般的なルーティングの方法は、コントローラーの “エイリアス” (ailias)を決めることです。 /users/some_action/5 の代わりに、 /cooks/some_action/5 で同じ場所にアクセスしたい場合、 以下のように簡単にできます。

Router::connect(
    '/cooks/:action/*', array('controller' => 'users')
);

これはルーターに /cooks/ で始まるすべてのURLは users コントローラに送るように伝えています。 アクションは :action の値によって呼ばれるかどうか決まります。 ルーティングのための要素 を使って、ユーザーの入力や変数を受け付けるいろいろなルーティングができます。 上記のルーティングの方法は、 /* を使います。 /*Router がすべての位置指定引数を受け取ることを意味します。 これらの引数は 渡された引数 配列で利用できるようになっています。

URLを生成するときにもルーティングは使われます。 もし最初に一致するものがあった場合、 array('controller' => 'users', 'action' => 'some_action', 5) を使って /cooks/some_action/5 と出力します。

デフォルトでは、すべての命名されてw足された引数は、テンプレートと照合して展開されます。 しかしながら、必要なときにどうやってどの命名された引数がパースされて Router::connectNamed() を使うのかを設定できます。

ルーティングのための要素

あなたは独自のルート要素を特定し、それはそのためにどこにコントローラのアクション のための値があるべきなのかを定義する力をあたえる。リクエストされたときに、ルート要素のための 変数がコントローラー上で $this->request->params によってみつけられる。 これは、どのように命名された引数を扱うかよりも難しい、なので、違いを記します。 命名された引数 (/controller/action/name:value) は $this->request->params['named'] で見つけられ、それと比較して、カスタムルーティング要素のデータは $this->request->params で見つけられます。 カスタムルーティング要素を定義した場合、正規表現をオプションで指定できます。 これはCakePHPにどんなURLが正しいフォーマットなのかを伝えます。 正規表現を使用しなかった場合、 / 以外はすべて値の一部として扱われます。:

Router::connect(
    '/:controller/:id',
    array('action' => 'view'),
    array('id' => '[0-9]+')
);

この単純な例は、どうやって素早くviewアクションをすべてのコントローラからURLによって /controllername/:id のような形で呼べるようにするかを示しています。 このURLは connect() で :controller:id という2つのルーティング要素を指定するために使われます。 この :controller 要素は CakePHP のデフォルトルーティング要素で、URLがどのコントローラーを示しているのか識別できます。 :id 要素はカスタムルーティング要素で、 connect() の第三引数の中で正規表現でより明確にされなければなりません。

注釈

ルーティング要素に使用している正規表現のパターンははすべてキャプチャーグループを含んではならない。 もし含んでいると、正しく動きません。

一度、ルートが定義されたら、 /apples/5 を呼ぶことは、 /apples/view/5 を呼ぶことと同じになります。 両方とも、ApplesControllerの view() メソッドを呼びます。 view() メソッドの中で、 $this->request->params['id'] で渡されたIDにアクセスする必要がある。

アプリの中で一つのコントローラーだけがあるとき、URLにコントローラー名が含まれている必要がない。 そのときは、すべてのURLがアクション名だけで一つのコントローラーに示すことができる。 たとえば、 home コントローラーにすべてのURLでアクセスするように設定したとして、 /home/demo の代わりに /demo というURLを使う場合以下の通りに設定します

Router::connect('/:action', array('controller' => 'home'));

もし、大文字小文字を区別しないURLを提供したいと思ったら、正規表現の修飾子だけを使えます。:

Router::connect(
    '/:userShortcut',
    array('controller' => 'teachers', 'action' => 'profile', 1),
    array('userShortcut' => '(?i:principal)')
);

もう一つ例を挙げます。これができたらプロ級

Router::connect(
    '/:controller/:year/:month/:day',
    array('action' => 'index'),
    array(
        'year' => '[12][0-9]{3}',
        'month' => '0[1-9]|1[012]',
        'day' => '0[1-9]|[12][0-9]|3[01]'
    )
);

これは、もっとカスタマイズしています。でも、ルーティングがとても強力になったことを示しています。 このURLは4つの要素を操作しています。1番目は、なじみがあります。デフォルトのルーティング要素で CakePHP にコントローラー名が必要なことを伝えています。

次に、デフォルト値を特定します。 コントローラーにかかわらず index() がをばれるようにしたい。

最後に、数字による”年月日”の表現と一致する正規表現を紹介します。この括り(グルーピング)は正規表現ではサポートされていません。
ほかにも特定可能ですが上記のように 括弧でくくりません。
一回定義されたら、このル-ティングが /articles/2007/02/01 , /posts/2004/11/16 に一致したら、
index() へのリクエストをそれが属するコントローラーに $this->request->paramsdate を格納して渡します。

いくつかの特別な意味を持つルーティング要素があります。 そして、特別な意味を持たせたくないなら、使ってはいけません。

  • controller コントローラー名に使います。
  • action アクション名に使います。
  • plugin コントローラーにあるプラグイン名に使います。
  • prefix プレフィックスルーティング のために使います。
  • ext 拡張子 ルーティングのために使います。

値をアクションに渡す

ルーティングのための要素 を使ってルーティングしている時に、ルーティング要素で 引数を渡したい時があると思います。 Router::connect() の第3引数でどのルーティング要素が引数として利用可能なのか定義できます。

// SomeController.php
public function view($articleId = null, $slug = null) {
    // some code here...
}

// routes.php
Router::connect(
    '/blog/:id-:slug', // E.g. /blog/3-CakePHP_Rocks
    array('controller' => 'blog', 'action' => 'view'),
    array(
        // order matters since this will simply map ":id" to
        // $articleId in your action
        'pass' => array('id', 'slug'),
        'id' => '[0-9]+'
    )
);

そして今、逆ルーティングのおかげで、下記のように url 配列を渡し、ルーティングで定義されたURLをどのように整えるのか Cakeは知ることができます。

// view.ctp
// これは /blog/3-CakePHP_Rocks へのリンクを返します。
echo $this->Html->link('CakePHP Rocks', array(
    'controller' => 'blog',
    'action' => 'view',
    'id' => 3,
    'slug' => 'CakePHP_Rocks'
));

ルーティングごとの名前付きパラメーター

Router::connectNamed() を使ってグローバル空間で名前付きパラメーターをコントロール可能な間、 名前付きパラメーターのルーティングレベルでの振る舞いを Router::connect() の第三引数を使って管理できます。

Router::connect(
    '/:controller/:action/*',
    array(),
    array(
        'named' => array(
            'wibble',
            'fish' => array('action' => 'index'),
            'fizz' => array('controller' => array('comments', 'other')),
            'buzz' => 'val-[\d]+'
        )
    )
);

上記のルーティングの定義は named キーを複数の名前付きパラメーターを管理するために使っています。 いくつかのルールを紹介します。 one-by-one:

  • ‘wibble’ は追加情報を持ちません。これは、URLがルーティングにマッチする場合、常にパースします。
  • ‘fish’ は一つの ‘action’ を含む配列を持ちます。これは、indexアクションの場合に名前付きパラメーターとしてパースされます。
  • ‘fizz’ は配列による条件指定を持ちます。しかし、二つのコントローラーを含みます。 その意味は、どちらかのコントローラーに入ったら一致するということです。
  • ‘buzz’ は文字列による条件指定を持ちます。 文字列は正規表現として扱われます。 パターンに一致したときのみパースされます。

名前付き引数が使われ、用意された基準と一致しない場合、渡された引数として名前付きパラメーターのかわりに 扱われます。

プレフィックスルーティング

多くのアプリケーションは特権を持ったユーザーが変更を加えられるよう 管理者領域を必要としている。 これはしばしば、特別な /admin/users/edit/5 のようなURLを通してなされます。 CakePHP ではプレフィックスルーティングをコア設定ファイルで設定可能です。 このプレフィックスがルーターにどのように関連づけられているかは、 app/Config/core.php で設定されます。

Configure::write('Routing.prefixes', array('admin'));

コントローラーでは、すべてのn admin_ プレフィックス付きのアクションが呼ばれることがあるでしょう。 このユーザーの例を使うと、 /admin/users/edit/5 にアクセスしたとき、 UsersControlleradmin_edit メソッドを5を第一引数として渡しながら呼びます。このとき app/View/Users/admin_edit.ctp にあるビューファイルを呼びます。 /admin へのアクセスを page コントローラーの admin_index アクションに以下のルーティング設定を使ってマップします。:

Router::connect(
    '/admin',
    array('controller' => 'pages', 'action' => 'index', 'admin' => true)
);

複数のプレフィックスを使ったルーティングも設定できます。 Routing.prefixes に変数を追加設定することでできます。もしこのように設定したら、:

Configure::write('Routing.prefixes', array('admin', 'manager'));

CakePHP は自動的に両方のプレフィックスを使用したルーティングをします。 それぞれの設定されたプレフィックスは以下のルーティングを生成します。

Router::connect(
    "/{$prefix}/:plugin/:controller",
    array('action' => 'index', 'prefix' => $prefix, $prefix => true)
);
Router::connect(
    "/{$prefix}/:plugin/:controller/:action/*",
    array('prefix' => $prefix, $prefix => true)
);
Router::connect(
    "/{$prefix}/:controller",
    array('action' => 'index', 'prefix' => $prefix, $prefix => true)
);
Router::connect(
    "/{$prefix}/:controller/:action/*",
    array('prefix' => $prefix, $prefix => true)
);
admin ルーティングのように、すべてのプレフィックス付きアクションは、プレフィックス名を持っています。
なので、 /manager/posts/addPostsController::manager_add() に対してマップされています。.

加えて、現在のプレフィックスはコントローラーのメソッドから $this->request->prefix を通して利用可能です。

プレフィックスルーティングを使っているときは、HTMLヘルパーをプレフィックスつけることを忘れないために使うことが大事です。 これが、リンクをHTMLヘルパーで作る方法です。

// プレフィックスルーティングする
echo $this->Html->link(
    'Manage posts',
    array('manager' => true, 'controller' => 'posts', 'action' => 'add')
);

// プレフィックスルーティングをやめる
echo $this->Html->link(
    'View Post',
    array('manager' => false, 'controller' => 'posts', 'action' => 'view', 5)
);

プラグインのためのルーティング

プラグインのためのルーティングには plugin キーを使います。 これでプラグインに対してのリンクを作れます。そのために plugin を添え字にしてURLを生成する配列に追加します。:

echo $this->Html->link(
    'New todo',
    array('plugin' => 'todo', 'controller' => 'todo_items', 'action' => 'create')
);

逆に、現在のリクエストがプラグインに対してのリクエストだったときに、プラグインでないリンクを生成したかったら・:

echo $this->Html->link(
    'New todo',
    array('plugin' => null, 'controller' => 'users', 'action' => 'profile')
);

plugin => null によってプラグインなしのリンクを設定できます。

拡張子

違う拡張子のファイルをルーティングで扱うためには、もう一行ルーティングの設定ファイルに追加します。:

Router::parseExtensions('html', 'rss');

これは、一致する拡張子をすべて除去して残りをパースします。

/page/title-of-page.html みたいなURLを生成したかったら、下記のようにします。:

Router::connect(
    '/page/:title',
    array('controller' => 'pages', 'action' => 'view'),
    array(
        'pass' => array('title')
    )
);

そして、ルーティングに対応するリンクを生成するために、以下のようにします。

$this->Html->link(
    'Link title',
    array(
        'controller' => 'pages',
        'action' => 'view',
        'title' => 'super-article',
        'ext' => 'html'
    )
);

拡張子が RequestHandlerComponent で使われ、それによって コンテンツタイプに合わせた自動的な振り分けがされます。 RequestHandlerComponent に詳細がありmす。

ルーティング条件に一致したときの追加の条件

ルーティングをリクエストと環境の設定によって決まったURLのみに限定したいときがあるでしょう。 これのよいたとえは、 REST ルーティングです。 $defaults 引数で Router::connect() のための追加の条件を特定できます。 デフォルトの CakePHP では3っつの環境条件があります。でも カスタムルーティングクラス を使ってもっと追加できます。 あらかじめ用意されているオプションは、 :

  • [type] 特定のコンテンツタイプにマッチするか。
  • [method] 特定の HTTP 動詞(verbs)を伴ったリクエストであるか。
  • [server] $_SERVER[‘SERVER_NAME’] が与えられた変数に一致するか。

簡単な例をここで紹介します。 [method] オプションを 使ってRESTフルなカスタムルーティングをします。:

Router::connect(
    "/:controller/:id",
    array("action" => "edit", "[method]" => "PUT"),
    array("id" => "[0-9]+")
);

これは PUT リクエストのときだけに一致します。 それらの条件を設定することで、 REST ルーティングやほかのリクエストデータ依存情報をカスタマイズすることができます。

渡された引数

渡された引数は追加の引数かリクエストを生成するときに使用されるパスセグメントです。 これらはしばしば、コントローラーメソッドにパラメーターを渡すために使われます。

http://localhost/calendars/view/recent/mark

上記のたとえでは、両方の recentmarkCalendarsController::view() に引数として渡されます。 渡された引数は3っつの方法でコントローラーに渡されます。 一番目は、引数としてアクションを呼ばれたときに渡し、2番目は、 $this->request->params['pass'] で数字を添え字とする配列で呼べるようになります。 最後は、 $this->passedArgs で2番目と同じ方法で呼べます。 カスタムルーティングを使用するときに、渡された引数を呼ぶために特定のパラメーターを強制することができます。

前のURLにアクセスしたい場合は、コントローラーアクションでこのようにします。

CalendarsController extends AppController {
    public function view($arg1, $arg2) {
        debug(func_get_args());
    }
}

下の出力を得ます:

Array
(
    [0] => recent
    [1] => mark
)

コントローラーとビューとヘルパーで $this->request->params['pass']$this->passedArgs でいくつかのデータが利用可能です。

配列には、URLの中での並び順に合わせた数字のキーとともに値が入れられます。

debug($this->request->params['pass']);
debug($this->passedArgs);

上記の出力は以下になります。:

Array
(
    [0] => recent
    [1] => mark
)

注釈

$this->passedArgs は名前付きパラメーターを、渡された引数と併せて名前付きの配列として含みます。

URLを ルーティング配列 を使って生成するとき、文字列による添え字なしで配列に引数を加えます:

array('controller' => 'posts', 'action' => 'view', 5)

5 は引数として渡されるときには数字キーを持ちます。

名前付きパラメーター

パラメーターに名前をつけてURLとして値を送れます。 /posts/view/title:first/category:general に対するリクエストが PostsController の view() を呼びます。そのアクションでは、 title と category の値を引数として $this->params['named'] で取り出せます。 $this->passedArgs でも取り出せます。 両方のケースでは、名前付きパラメーターにインデックスを使ってアクセスできます。 名前付きパラメーターが省略された場合それらはセットされません。are omitted, they will not be set.

注釈

名前付きパラメーターとしてパースされたものは、 Router::connectNamed() によって制御されます。もし、名前付きパラメーターが逆ルーティングされていないか 正しくパースされていれば、 Router にそれらの情報を伝える必要があるでしょう。

デフォルトルーティングの例をいくつかまとめて出します。:

URL to controller action mapping using default routes:

URL: /monkeys/jump
Mapping: MonkeysController->jump();

URL: /products
Mapping: ProductsController->index();

URL: /tasks/view/45
Mapping: TasksController->view(45);

URL: /donations/view/recent/2001
Mapping: DonationsController->view('recent', '2001');

URL: /contents/view/chapter:models/section:associations
Mapping: ContentsController->view();
$this->passedArgs['chapter'] = 'models';
$this->passedArgs['section'] = 'associations';
$this->params['named']['chapter'] = 'models';
$this->params['named']['section'] = 'associations';

カスタムルーティングするときに、よくある落とし穴lは名前付きパラメーターがカスタムルーティングを壊すことです。 これを解決するためには、ルーターにどのパラメーターが名前付きパラメーターと指定とされているのか伝える必要があります。 この知識なしでは、ルーターは名前付きパラメーターが本当に名前付きパラメーターなのかルーティングパラメーターなのか区別できません。 加えて、デフォルトでは、 ルーティングパラメーターであるとみなします。 名前付きパラメーターにルーティングで接続するときには、 Router::connectNamed() を使います。:

Router::connectNamed(array('chapter', 'section'));

これは chapter(章) と section(項目) パラメーターを確実に正しくリバースルーティングするようにします。

URLを生成するときに、 ルーティング配列 を名前付きパラメーターを文字列キーが名前に一致する値として追加するために使います。

array('controller' => 'posts', 'action' => 'view', 'chapter' => 'association')

‘chapter’ がすべての定義されたルーティング要素に一致しなければ、名前付きパラメーターとして扱われます。

注釈

療法の名前付きパラメーターとルーティング要素は名前キー空間を共有します。 これはルーティング要素と名前付きパラメーターの療法を再使用することを避けるもっともよい方法です。

名前付きパラメーターはまたURLをパースし生成するための配列をサポートします。 この文法は GET で使われる配列の文法ととても似た働きをします。URLを生成するときに以下の文法を使えます。

$url = Router::url(array(
    'controller' => 'posts',
    'action' => 'index',
    'filter' => array(
        'published' => 1,
        'frontpage' => 1
    )
));

/posts/index/filter[published]:1/filter[frontpage]:1 というURLが上記のコードで生成されます。 このパラメーターはコントローラーの passedArgs 変数に Router::url に送るために 配列として保存されパースされます。just as you sent them to

$this->passedArgs['filter'] = array(
    'published' => 1,
    'frontpage' => 1
);

配列は渡された引数と同じぐらい柔軟に深くネストできます。

$url = Router::url(array(
    'controller' => 'posts',
    'action' => 'search',
    'models' => array(
        'post' => array(
            'order' => 'asc',
            'filter' => array(
                'published' => 1
            )
        ),
        'comment' => array(
            'order' => 'desc',
            'filter' => array(
                'spam' => 0
            )
        ),
    ),
    'users' => array(1, 2, 3)
));

とても長いURLも簡単に読めるようにラップして使えます。

posts/search
  /models[post][order]:asc/models[post][filter][published]:1
  /models[comment][order]:desc/models[comment][filter][spam]:0
  /users[]:1/users[]:2/users[]:3

コントローラーに渡された配列での結果出力以下のルーターに渡された配列と一致します。

$this->passedArgs['models'] = array(
    'post' => array(
        'order' => 'asc',
        'filter' => array(
            'published' => 1
        )
    ),
    'comment' => array(
        'order' => 'desc',
        'filter' => array(
            'spam' => 0
        )
    ),
);

名前付きパラメーターの制御

名前付きパラメーターの設定をルーティングごとまたは、全て一度に設定することができます。 Router::connectNamed() ですべての設定を一土に変えられます。 下記にいくつかの名前付きパラメーターを connectNamed() でパースして制御する例を出します。

すべての名前付きパラメーターをパースしない:

Router::connectNamed(false);

Cakeのページネーションで使うデフォルトのパラメーターだけパースする。

Router::connectNamed(false, array('default' => true));

数字の page パラメーターだけパースする。:

Router::connectNamed(
    array('page' => '[\d]+'),
    array('default' => false, 'greedy' => false)
);

すべての page パラメーターをパースする:

   Router::connectNamed(
       array('page'),
       array('default' => false, 'greedy' => false)
   );

'index' アクションが呼ばれた時、**page** パラメーターをパースする::

   Router::connectNamed(
       array('page' => array('action' => 'index')),
       array('default' => false, 'greedy' => false)
   );

 コントローラーが 'pages'  'index' アクションが呼ばれた時、**page** パラメーターをパースする::

   Router::connectNamed(
       array('page' => array('action' => 'index', 'controller' => 'pages')),
       array('default' => false, 'greedy' => false)
   );

connectNamed() は色々なオプションをサポートしています。:

  • greedy を true に設定すると、すべての名前付きパラメーターをパースするようになります。 false にすると、接続された名前付きパラメーターだけパースします。
  • default を true に設定すると、名前付きパラメーターの集合にマージされます。
  • reset を true に設定すると、既存のルールを消します。
  • separator 文字列を変更すると、名前付きパラメーターの区切りを変えられます。デフォルトでは : です。

リバースルーティング

リバースルーティングは CakePHP のすべてのコードの変更なしにURLの構造を簡単に変更する機能です。 ルーティング配列 をURLを定義するために使えます。 あとで変更を加えても、生成されたURLは自動的にアップデートされます。

URLを文字列によって以下のように生成します。:

$this->Html->link('View', '/posts/view/' . $id);

/posts がすべての残りのURLを通して本当に ‘articles’ の代わりに呼ばれるかあとで決められます。 また、リンクを以下のように定義した場合、:

$this->Html->link(
    'View',
    array('controller' => 'posts', 'action' => 'view', $id)
);

そして、URLを変えたいと思ったら、ルーティングを定義することでできます。 これは両方受け取るURLマッピングも生成するURLも変えます。

配列のURLを使うとき、文字列パラメーターによるクエリと、特定のキーによるドキュメントフラグメントを定義できます。:

Router::url(array(
    'controller' => 'posts',
    'action' => 'index',
    '?' => array('page' => 1),
    '#' => 'top'
));

// こんなURLが生成されます
/posts/index?page=1#top

リダイレクトルーティング

リダイレクトルーティングは入ってくるルーティングに HTTP ステータスの 30x リダイレクトを発行し違うURLに転送することができます。 これはクライアントアプリケーションにリソースが移動したことを同じコンテンツに対して2つのURLが存在することを知らせずに伝えるために使えます。

リダイレクトルーティングは通常のルーティング条件に一致した時の実際のヘッダーリダイレクトと違います。 これは、 アプリケーションかプリケーションの外に対してのリダイレクトのためにおきます。:

Router::redirect(
    '/home/*',
    array('controller' => 'posts', 'action' => 'view'),
    // もしくは$idを引数として受け取るviewアクションデフォルトルーティングのための
    //array('persist'=>array('id'))
    array('persist' => true)
);

/home/* から /posts/view へのリダイレクトと /posts/view にパラメーターを渡すこと 配列をルートリダイレクト先を表現するために使うことで、文字列のURLがリダイレクトしている先を定義できるようにします。 文字列のURLで外部にリダイレクトできます。:

Router::redirect('/posts/*', 'http://google.com', array('status' => 302));

これは、 /posts/* から http://google.com へwith a HTTP 302 ステータスを出しながらリダイレクトさせます。

デフォルトルーティングの無効化

フルカスタマイズされたルーティングをして、重複するコンテンツによる検索エンジンのペナルティを回避していた場合、
routes.php から削除することで、Cakeのデフォルトルーティングを削除することができます。

これは CakePHP 通常提供するURLに明示的にアクセスしなかった時にがエラーを吐く原因になります。

カスタムルーティングクラス

カスタムルーティングクラスは個別のルーティングが リクエストをパースしてリバースルーティングを扱えるようにします。 カスタムルーティングクラスは app/Routing/Route に作られ、 CakeRoute を拡張して、 match()parse() の一方もしくは両方を使います。 parse() はリクエストをパースするために使われ、 match() はリバースルーティングの制御に使われます。

カスタムルーティングクラスを routeClass オプションを使って設定する時と 、ルーティング設定を含むファイルをルーティングするまえに読み込むことで使えます。:

App::uses('SlugRoute', 'Routing/Route');

Router::connect(
     '/:slug',
     array('controller' => 'posts', 'action' => 'view'),
     array('routeClass' => 'SlugRoute')
);

このルーティングは SlugRoute のインスタンスを生成し、任意のパラメーター制御を提供します。

ルーティング API

class Router

ルーティングマネージャーはURを生成し、受け取ったCakeが送信するパラメーターセットの中のリクエストURIをパースします。

static Router::connect($route, $defaults = array(), $options = array())
パラメータ:
  • $route (string) – ルーティングテンプレートを表現する文字列
  • $defaults (array) – デフォルトのルーティングパラメーターを表現する配列。 これらのパラメーターはデフォルトで使われ、ルーティングパラメーターを静的に提供します。
  • $options (array) – 名前要素に一致した配列かつルーティングの正規表現に一致したもの。 また、渡されることになるルーティングパラメーターや、ルーティングパラメーターのパターンや カスタムルーティングクラスの名前の提供ができる追加のパラメーターを含みます。
ルーティングはリクエストされたURLをオブジェクトで制御する方法です。
それらのコアルーティングはリクエスト先を一致しさせるための正規表現のセットです。

例:

Router::connect('/:controller/:action/*');

最初のパラメーターはコントローラー名として使われ、二番目はアクション名として使われます。 ‘/*’ 構文 はこのルートを貪欲にして /posts/index のようなリクエストだけではなく /posts/edit/1/foo/bar のようなリクエストにも一致するようにします。

Router::connect(
    '/home-page',
    array('controller' => 'pages', 'action' => 'display', 'home')
);

上記は、デフォルトのルーティングパラメーターの使い方を示してます。 そして、それは静的ルーティングのためのルーティングパラメーターを提供します。

Router::connect(
    '/:lang/:controller/:action/:id',
    array(),
    array('id' => '[0-9]+', 'lang' => '[a-z]{3}')
);

これは、それらのパラメーターために用意されたパターンと同じように カスタムルーティングパラメーターでにルーティング接続する例です。

$options は3つの pass, persistrouteClass という特殊キーを持ちます。

  • pass はどのパラメーターが配列に渡されるのかを定義するために使われます。 渡すためにパラメーターを追加することで、それを正規のルーティング配列から削除できます。 例えば、 'pass' => array('slug') のように。
  • persist はURLを新規に生成したときに、どのルーティングパラメーターが 自動的にインクルードされるのかを定義するために使われます。 URLで再定義することで一定のパラメーターをオーバーライドしたり、 false に設定することで除去できます。たとえば、 'persist' => array('lang') のように。
  • routeClass は個別のルーティングがどのようにリクエストをパースするのかを 拡張し変更するためと、リバースルーティングを 'routeClass' => 'SlugRoute' のような カスタムルーティングクラスによって制御するために使われます。
  • named は名前付きパラメーターをルーティングレベルで設定するために使われます。 このキーは Router::connectNamed() と同じオプションを使います。
static Router::redirect($route, $url, $options = array())
パラメータ:
  • $route (string) – どのURLがリダイレクトされるのかを決めるルーティングテンプレート
  • $url (mixed) – ルーティング配列 かリダイレクト先の文字列URLを入れる。
  • $options (array) – リダイレクトオプションを表す配列。

新しいリダイレクトにルーティング接続します。 リダイレクトルーティング に詳細があります。

static Router::connectNamed($named, $options = array())
パラメータ:
  • $named (array) – 名前付きパラメーターのリスト。添字のペアが 正規表現に一致するか配列であった時に受け付けられます。
  • $options (array) – separator, greedy, reset, default などの設定をすべてを制御します。

CakePHP でどの名前付きパラメーターなのか特定するには、入ってきたURLを出力します。 デフォルトの CakePHP は全部の入ってきたURLにある名前付きパラメーターをパースします。 名前付きパラメーターの制御 に詳細があります。

static Router::promote($which = null)
パラメータ:
  • $which (integer) – ゼロからはじまる配列の添え字はルーティングの移動先を表しています。 例えば、3っつのルートが追加された時、最後の添字は2になります。

リストの先頭にルート (デフォルトでは、最後に追加されたもの)を昇格させます。

static Router::url($url = null, $full = false)
パラメータ:
  • $url (mixed) – “/products/edit/92” や “/presidents/elect/4” や ルーティング配列 のようにCakeに関連するURL
  • $full (mixed) –
    (boolean) true になっていたら、URLフルパスが出力されます。
    これは以下のキーを受け付けます。
    • escape - used when making URLs embedded in HTML escapes query string ‘&’
    • full - true になっていたら、URLフルパスが先頭に追加されて出力されます。

Generate a URL for the specified action.特定のアクションのためのURLを生成します。 コントローラー、アクションもしくは $url の組み合わせて表現可能なURLを返します。

  • Empty - このメソッドは実際のコントローラーアクションへのアドレスを見つけます。
  • ‘/’ - このメソッドは、ベースURLを見つけます。
  • コントローラーをアクションの組み合わせ - そのためのURLを見つけます。

いくつかの最後に生成されたURL文字列を変える特殊パラメーターがあります。

  • base - false にセットすると、ベースURLを除去します。 ルートディレクトリに作っているアプリがない場合、 ‘CakePHP relative’ なURLの生成に使えます。 “CakePHP relative” なURLs は requestAction を使うときに必要とされます。.
  • ? - 文字列クエリの配列を取ります。
  • # - URLのハッシュフラグメントをセットします。
  • full_base - true にすると、 Router::fullBaseUrl() が 生成されたURLの前に加えられます。
static Router::mapResources($controller, $options = array())

与えられたコントローラーのために 渡されたREST をもとにどのようにルーティングするか決めます。 詳細は REST ここです。

static Router::parseExtensions($types)

routes.php でサポートする拡張子( 拡張子 )を宣言するために使われます。 引数を用意しないことで、すべての拡張子をサポートします。

static Router::setExtensions($extensions, $merge = true)

バージョン 2.2 で追加.

利用可能な拡張子をセットしたり追加します。これで設定したとしても、 拡張子をパースするために Router::parseExtensions() を呼ぶ必要があります。.

static Router::defaultRouteClass($classname)

バージョン 2.1 で追加.

デフォルトルートは接続するときに時に使われます。

static Router::fullBaseUrl($url = null)

バージョン 2.4 で追加.

生成するURLをに使われる baseURL 。 この値を設定するときには、 確かなプロトコルを含むドメイン名を使う必要があります。

このメソッドで値をセットすると、 ConfigureApp.fullBaseUrl をアップデートします。.

class CakeRoute

カスタムルーティングのためのベースクラス。

CakeRoute::parse($url)
パラメータ:
  • $url (string) – The string URL to parse.

ディスパッチャーがそれを使って動くように、受け取ったURLをパースとリクエストパラメーターの配列を生成する。 このメソッドを確証することで、受け取ったURLが配列に変換される方法をカスタマイズできます。 URLから一致さなかったときに false を返されます。

CakeRoute::match($url)
パラメータ:
  • $url (array) – The routing array to convert into a string URL.

URLは、ルートパラメータと設定に一致する場合、生成された文字列のURLを返します。 URLがルートパラメーターと一致しない場合 false が返されます。このメソッドは、 ????文字列のURLへの逆ルーティングまたはURL配列の変換をします。

CakeRoute::compile()

正規表現をコンパイルすることを強制します。