forked from fuel/docs
/
uri.html
562 lines (532 loc) · 17 KB
/
uri.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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
<!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 = "Uri::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Uri - クラス - FuelPHP ドキュメント</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<strong>FuelPHP, a PHP 5.3 Framework</strong>
Documentation
</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>Uri クラス</h2>
<p>Uri クラスは URI を対話的に扱うことができます。</p>
<article>
<h4 class="method" id="method_base">base($include_index = true)</h4>
<p>
<strong>base</strong> メソッドはベース URL を返します。
なお、 $include_index を <em>false</em> にセットした場合は、 index_file (インデックスファイル名) を除いた URL を返します。
</p>
<p class="note">
注意してください : もし app/config/config.php で index_file がセットされていない場合は <strong>$include_index</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>$include_index</kbd></th>
<td><pre class="php"><code>true</code></pre></td>
<td>返り値の url に対してインデックスを付加するかどうかを決めます。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string 、オプションとしてインデックスファイル名が付加されることがあるベース url を返します。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Uri::base();
// http://localhost/index.php
echo Uri::base(false);
// http://localhost/</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_create">create($uri = null, $variables = array(), $get_variables = array(), $secure = null)</h4>
<p><strong>create</strong> メソッドは、与えられた URI を加えた URL を生成することが出来ます。その URL にはベース URL を含みます。</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>$uri</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>URL</td>
</tr>
<tr>
<th><kbd>$variables</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>URL のための各種変数。</td>
</tr>
<tr>
<th><kbd>$get_variables</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>URL に付加されるクエリ文字列。その値とキーは $variables 配列から得られた変数を
利用することが出来ます。</td>
</tr>
<tr>
<th><kbd>$secure</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>生成される URL は、本項が false の場合は http 、 true の場合は https となります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>echo Uri::create('controller/method');
// http://localhost/controller/method が返ります
echo Uri::create('controller/:some', array('some' => 'thing', 'and' => 'more'), array('what' => ':and'));
// http://localhost/controller/thing?what=more が返ります
echo Uri::create('http://www.example.org/:some', array('some' => 'thing', 'and' => 'more'), array('what' => ':and'));
// http://www.example.org/thing?what=more が返ります
echo Uri::create('http://www.example.org/:some', array('some' => 'thing', 'and' => 'more'), array('what' => ':and'), true);
// https://www.example.org/thing?what=more が返ります</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_current">current()</h4>
<p><strong>current</strong> メソッドを用いると、現在の URL を取得出来ます。URL には HMVC パターン内部で定義されているベース URL が含まれます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>無し</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// URL 例 : http://localhost/module/controller/method
echo Uri::current(); // http://localhost/module/controller/method が返ります</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_main">main()</h4>
<p><strong>main</strong> メソッドでベース URL を含む現在の URL を取得することが出来ます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>無し</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// URL 例 : http://localhost/controller/method
echo Uri::main(); // http://localhost/controller/method が返ります</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_segment">segment($segment, $default = null)</h4>
<p><strong>segment</strong> メソッドを用いると、取得したい特定の url セグメントを得ることができます。そのセグメントが存在しない場合は、 false が返されます。</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>$segment</kbd></th>
<td><i>必須</i></td>
<td>セグメント番号。</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>デフォルト？ (The default?)</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// URL 例 : http://localhost/controller/method/param1/param2
echo Uri::segment(3); // param1 が返ります</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_segments">segments()</h4>
<p><strong>segments</strong> メソッドによって、現在の URI セグメント全てを配列で取得することが出来ます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>無し</td>
</tr>
<tr>
<th>返り値</th>
<td>array</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// URL 例 : http://localhost/controller/method
echo Uri::segments(); // array(0 => 'controller', 1 => 'method') が返ります</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_segment_replace">segment_replace($url, $secure = null)</h4>
<p><strong>segment_replace</strong> メソッドは、与えられた url の中にあるワイルドカードを、その場所にある現在の 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>$url</kbd></th>
<td><i>必須</i></td>
<td>ワイルドカードを含んだ URL 。ワイルドカード文字は * (アスタリスク) で表されます。</td>
</tr>
<tr>
<th><kbd>$secure</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>返される URL は、本項が false の場合は HTTP 、 true の場合は HTTPS となります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例外</th>
<td>OutOfBoundsException 。もし、ワイルドカードが置かれた場所にあるセグメントの値が存在しなかった場合。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 例 : 現在の URL = http://localhost/one/two 、'one' と 'two' のセグメントを持っている
// http://localhost/one/two/three を返す
echo Uri::segment_replace('http://localhost/*/*/three');
// 3 番目のセグメントが存在しなかったとして、例外を投げる
echo Uri::segment_replace('http://localhost/this/that/*/other');
// returns https://localhost/one/two/three
echo Uri::segment_replace('http://localhost/*/*/three', true);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_update_query_string">update_query_string($vars = array(), $uri = null, $secure = null)</h4>
<p>
<strong>update_query_string</strong> メソッドは、現在の URI または渡された 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>$vars</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>クエリ変数の連想配列、または変数名を含んだ文字列。</td>
</tr>
<tr>
<th><kbd>$uri</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>
使用する url 。与えられなければ、現在の url が使われます。$vars が文字列ならば、
これは変数の値を含みます（このケースでは、カスタム uri を渡すことができないということです！）。
</td>
</tr>
<tr>
<th><kbd>$secure</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>返される URL は、本項が false の場合は HTTP 、 true の場合は HTTPS となります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 例 : 現在の URL = http://localhost/test?one=1&two=2
// http://localhost/test?one=1&two=2&three=3 を返す
echo Uri::update_query_string(array('three' => 3));
// http://localhost/test?one=1&two=3 を返す
echo Uri::update_query_string(array('two' => 3));
// http://localhost/controller?four=4 を返す
echo Uri::update_query_string(array('four' => 4), 'http://localhost/controller');
// https://localhost/test?one=1&two=2&three=3 を返す
echo Uri::update_query_string('three', 3, true);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_to_assoc">to_assoc($start = 1)</h4>
<p><strong>to_assoc</strong> メソッドはセグメントが偶数の場合、それを配列化して連想配列にします。奇数の場合は、最後のキーの値は <code>null</code> を返します。</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>$start</kbd></th>
<td><pre class="php"><code>1</code></pre></td>
<td>始まりのセグメント番号。これによって、主要なセグメントだけを取り出すことができます。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>array</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// Uri が /welcome/index/page/4 の場合
$arr = Uri::to_assoc();
/*
結果 :
array(
'welcome' => 'index',
'page' => 4,
);
*/
// Uri が /welcome の場合
$arr = Uri::to_assoc();
/*
結果 :
array(
'welcome' => null,
);
*/</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_string">string()</h4>
<p><strong>string</strong> メソッドを用いると、現在の URI を取得出来ます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>無し</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// URL 例 : http://localhost/controller/method
echo Uri::string(); // controller/method が返ります</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_build_query_string">build_query_string($values ...)</h4>
<p>
<strong>build_query_string</strong> メソッドは、1 つ以上の連想配列か文字列値を渡してクエリ文字列を生成します。
既存のものから最新のクエリ文字列を組み立てるために Input::get() の中で渡すことができます。
文字列を渡す場合、スイッチとみなされて "string=1" に変換されます。
</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>$values</kbd></th>
<td><i>必須</i></td>
<td>1 つ以上の連想配列または文字列値</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// "varA=varA&varB=1&varC=varC" が返ります
echo Uri::build_query_string(array('varA' => 'varA'), 'varB', array('varC' => 'varC'));</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2013 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.7/develop/classes/uri.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.7/develop_japanese/classes/uri.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.7/develop_japanese/classes/uri.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>