forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
router.html
338 lines (314 loc) · 12.2 KB
/
router.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!doctype html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Router::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Router - クラス - FuelPHP ドキュメント</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<a href="http://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="検索" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">目次</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Router クラス</h2>
<p><kbd>Router</kbd> クラスは、渡されたリクエストと定義されたルートに従い、どのコントローラが読み込まれるかを決定します。 </p>
<article>
<h4 class="method" id="method_process">process(\Request $request, $route = true)</h4>
<p>
<strong>process</strong> メソッドは、request オブジェクトを受け取り、リクエストに含まれる URI から、マッチするルートを見つけようとします。
もし、どのルートにもマッチしなかった場合、router は、URI の中の情報に基づいた新しいルート、および controller/method や module/controller/method といった URI スキーマを作成します。
決められたルートが有効かどうかはチェックされません。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$request</kbd></th>
<td><i>必須</i></td>
<td>有効な Request オブジェクト。</td>
</tr>
<tr>
<th><kbd>$route</kbd></th>
<td><code>true</code></td>
<td>
もし 'true' の場合、読み込まれたルートはマッチを見つけるために使われます。もし 'false' の場合、読み込まれたルートは無視され新しいルートが構築されます。
これは、URL からルーティングできていないコントローラへの HMVC 呼び出しに使われます。
</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><i>Route オブジェクト、または有効な route オブジェクトが構築できなければ null</i></td>
</tr>
</tbody>
</table>
<p class="note">
通常の使用方法では、このメソッドを必要としません。これは、コントローラを読み込むために、
フレームワークの内部で使用されます。
</p>
</article>
<article>
<h4 class="method" id="method_add">add($path, $options = null, $prepend = false, $case_sensitive = null)</h4>
<p>
<strong>add</strong> メソッドは、実行時に手動で新しいルートを追加することができます。
正常な URI スキームでたどることができないコントローラを読み込みたい、または routes.php の設定ファイル以外のソースからルートを読み込みたければ、
これが必要になるかもしれません。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><i>必須</i></td>
<td>一致させたい URI パス。これは、routes.php にあるルート定義の左側です。</td>
</tr>
<tr>
<th><kbd>$options</kbd></th>
<td><i>string|array|Route</i></td>
<td>$path に対しての変換、HTTP メソッドルーティングの配列 (routes.php にあるルート定義の右側のように) 、または Route インスタンス。</td>
</tr>
<tr>
<th><kbd>$prepend</kbd></th>
<td><code>false</code></td>
<td>もし true の場合、既に読み込まれているルートの先頭に新しいルートを追加します。</td>
</tr>
<tr>
<th><kbd>$case_sensitive</kbd></th>
<td><code>null</code></td>
<td>もし false の場合、新しいルートは URI の大文字小文字を区別しないとしてマッチさせます。もし true の場合、マッチは大文字小文字を区別します。もし指定がなければ、設定されているデフォルトが使われます。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><i>void</i></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 新しいルート 'this/that' => 'something/else' を読み込む
Router::add('this/that', 'something/else');
// 大文字小文字を区別する
Router::add('this/that', 'something/else', true);
// 大文字小文字を区別しない Route インスタンスを手動で作成する
$path = 'this/that';
Router::add($path, new Route($path, 'something/else', false));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_get">get($name, $named_params = array())</h4>
<p>
<strong>get</strong> メソッドは、名前付きルートに対してリバースルーティングをすることができます。
渡された名前に基づいて、定義されているパスを検索し、ビューの中で使用できる URI を返します。
これは、あなたがルートを変更すれば、ビューの中のリンクがその都度更新されるということです。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td><kbd>null</kbd></td>
<td>読み込むルートの名前。</td>
</tr>
<tr>
<th><kbd>$named_params</kbd></th>
<td><code>array()</code></td>
<td>作成した URI に追加するパラメータの配列。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><kbd>bool|array</kbd></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// このようにルートを定義した場合:
return array(
'_root_' => 'welcome/index', // デフォルトルート
'_404_' => 'welcome/404', // メインの 404 ルート
'hello(/:name)?' => array('welcome/hello', 'name' => 'hello'),
);
// この呼び出しは 'http://your_base_url/welcome/hello' を返す
echo Router::get('hello');
</code></pre>
<br />
<p>
ルートに名前付きパラメータ、正規表現、または両方の組み合わせを含めて、この様にもできます。
</p>
<pre class="php"><code>// ルートをこの様に定義した場合:
return array(
'thread/(?P<thread_id>\d+?)/post' => array('post', 'name' => 'post'),
);
// これらは 'thread/1/post' を返す:
echo Router::get('post', array('thread_id' => 1));
echo Router::get('post', array('$1' => 1));
echo Router::get('post', array(1));
// ルートをこの様に定義した場合:
return array(
'country/(?P<country>\d+?)/state/(?P<state>\d+?)/location' => array('location', 'name' => 'location'),
);
// これらは 'country/japan/state/tokyo/location' を返す:
echo Router::get('location', array('country' => 'japan', 'state' => 'tokyo'));
echo Router::get('location', array('$1' => 'japan', '$2' => 'tokyo'));
echo Router::get('location', array('japan', 'tokyo'));
echo Router::get('location', array('country' => 'japan', 'tokyo'));
echo Router::get('location', array('$1' => 'japan', 'tokyo'));
</code></pre>
<br />
<p class="note">
ルートに従来の正規表現と名前付きパラメータまたは正規表現ショートカットが混在して含まれている場合、
それらが共に変換されて、予期しない結果になってしまうかもしれないということに注意してください。
</p>
<pre class="php"><code>// ルートをこの様に定義した場合:
return array(
'hello/(:name)(/:segment)' => array('welcome/user', 'name' => 'user'),
);
// "(/:segment)" は "article" によって中身が完全に変換されてしまうことに注意してください、
// したがって、この呼び出しは 'http://your_base_url/welcome/user/johnarticle' を返す。
echo Router::get('user', array('name' => 'john', 'article'));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_delete">delete($path, $case_sensitive = null)</h4>
<p>
<strong>delete</strong> メソッドは、実行時に手動で既にあるルートを削除します。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><i>必須</i></td>
<td>一致させたい URI パス、またはパスの配列。これは、routes.php にあるルート定義の左側です。</td>
</tr>
<tr>
<th><kbd>$case_sensitive</kbd></th>
<td><code>null</code></td>
<td>もし false の場合、指定したルートパスは URI の大文字小文字を区別しないとしてマッチさせます。もし true の場合、マッチは大文字小文字を区別します。もし指定がなければ、設定されているデフォルトが使われます。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><i>void</i></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 'this/that' に対するルートを削除
Router::delete('this/that');
// 'this/that' と 'some/other' に対するルートを削除
Router::delete(array('this/that', 'some/other'));
// 大文字小文字を区別することを強制
Router::delete('this/that', true);
// module controller への全てのルートを削除する
Router::delete('module/controller(:any)');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2016 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.8/develop/classes/router.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/router.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/router.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>