forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
response.html
577 lines (545 loc) · 19.1 KB
/
response.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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<!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 = "Response::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Response - クラス - 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>Response クラス</h2>
<p>Response クラスは HTTP レスポンスとブラウザ出力を扱うメソッドを含んでいます。</p>
<article>
<h4>ステータスヘッダを設定する</h4>
<p>Fuel において、ステータスヘッダは "特別の" ヘッダとして扱われます。設定の仕方も、他のヘッダとは同じではありません。
コントローラの中で次のように設定します:</p>
<pre class="php"><code>$response = new Response($body, 404);</code></pre>
<h4>ステータスヘッダと他のヘッダをセットする</h4>
<pre class="php"><code>$headers = array (
'Cache-Control' => 'no-cache, no-store, max-age=0, must-revalidate',
'Expires' => 'Mon, 26 Jul 1997 05:00:00 GMT',
'Pragma' => 'no-cache',
);
$response = new Response($body, 404, $headers);</code></pre>
</article>
<article>
<h4 class="method" id="method_forge">forge($body = null, $status = 200, array $headers = array())</h4>
<p><strong>forge</strong> メソッドは、Response クラスの新しいインスタンスを生成します。</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>$body</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>レスポンス本文。つまりあなたがユーザに返したいレスポンス。</td>
</tr>
<tr>
<th><kbd>$status</kbd></th>
<td><pre class="php"><code>200</code></pre></td>
<td>HTTP ステータスコード。デフォルトは、200 OKです。</td>
</tr>
<tr>
<th><kbd>$headers</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>レスポンスになりうる、あらゆる HTTP ヘッダ</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Response オブジェクト</td>
</tr>
<tr>
<th>トリガー</th>
<td>オブジェクトのインスタンス化後の 'response_created' イベント</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// response オブジェクトを作成する。View を body として使い、ステータスコードは 404 Not Found とする
return Response::forge(View::forge('errors/404page'), 404);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_redirect">redirect($url = '', $method = 'location', $redirect_code = 302)</h4>
<p><strong>redirect</strong>メソッドは、 新しい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>$url</kbd></th>
<td><pre class="php"><code>''</code></pre></td>
<td>リダイレクトするURL</td>
</tr>
<tr>
<th><kbd>$method</kbd></th>
<td><pre class="php"><code>'location'</code></pre></td>
<td>リダイレクト方法。'location' と 'refresh'がサポートされます。</td>
</tr>
<tr>
<th><kbd>$redirect_code</kbd></th>
<td><pre class="php"><code>302</code></pre></td>
<td>リダイレクトとして送信されるHTTPステータスコード</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>このメソッドは、現在のスクリプトを終了し、値を返却しません。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// URL を使う
Response::redirect('http://example.com/home', 'refresh');
// 相対 URI を使うこともできる
Response::redirect('site/about');</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
このメソッドは、URLのワイルドカードによる置換をサポートします。<a href="uri.html#method_segment_replace">Uri::segment_replace()</a> をご覧ください。
アプリケーションの config.php で <code>response.redirect_with_wildcards</code> を <code>false</code> に設定すると、この機能を無効にできます。
</p>
</article>
<article>
<h4 class="method" id="method_redirect_back">redirect_back($url = '', $method = 'location', $redirect_code = 302)</h4>
<p><strong>redirect_back</strong> メソッドを使うと、現在のページに来る前のページにリダイレクトしたり、新しい URL にリダイレクトさせることができます。
前のページが自身のアプリケーションの一部ではない(つまり、ユーザーが別の Web サイトから来た)場合や 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>$url</kbd></th>
<td><pre class="php"><code>''</code></pre></td>
<td>リダイレクト先の URL</td>
</tr>
<tr>
<th><kbd>$method</kbd></th>
<td><pre class="php"><code>'location'</code></pre></td>
<td>使用するリダイレクションメソッド。'location' と 'refresh' がサポートされています。</td>
</tr>
<tr>
<th><kbd>$redirect_code</kbd></th>
<td><pre class="php"><code>302</code></pre></td>
<td>リダイレクトの一部として返される HTTP ステータスコード</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>このメソッドは、現在のスクリプトを終了し、値を返却しません。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 前のページにリダイレクトする。「前のページ」がなければ、dashboard ページに移動する
Response::redirect_back('/dashboard', 'refresh');</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
このメソッドは、URLのワイルドカードによる置換をサポートします。<a href="uri.html#method_segment_replace">Uri::segment_replace()</a> をご覧ください。
アプリケーションの config.php で <code>response.redirect_with_wildcards</code> を <code>false</code> に設定すると、この機能を無効にできます。
</p>
</article>
<article>
<h4 class="method" id="method_set_status">set_status($status = 200)</h4>
<p><strong>set_status</strong> メソッドは、ResponseオブジェクトのHTTP ステータスコードを更新します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>No</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$status</kbd></th>
<td><pre class="php"><code>200</code></pre></td>
<td>HTTP ステータスコード。デフォルトは、200 OK です。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>現在のオブジェクト、メソッドチェーン用</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$response = new Response();
// NOT FOUND response が返る
$response->set_status(404);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_set_header">set_header($name, $value, $replace)</h4>
<p><strong>set_header</strong> メソッドは、カスタムHTTP ヘッダをセットします。</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><i>必須</i></td>
<td>付け加えるヘッダ名。</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>説明</i></td>
<td>HTTP ヘッダに付加される必要がある文字列です。</td>
</tr>
<tr>
<th><kbd>$replace</kbd></th>
<td><pre class="php"><code>true</code></pre></td>
<td>デフォルトでは同名のヘッダの値はすべて置き換えられます。<kbd>false</kbd> がセットされた場合は、ヘッダの書き換えはありませんし、書き換え出来ません。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Response</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$response = new Response();
// PDF を出力します
$response->set_header('Content-Type', 'application/pdf');
// downloaded.pdf がコールされます
$response->set_header('Content-Disposition', 'attachment; filename="downloaded.pdf"');
// キャッシュをなしにします
$response->set_header('Cache-Control', 'no-cache, no-store, max-age=0, must-revalidate');
$response->set_header('Expires', 'Mon, 26 Jul 1997 05:00:00 GMT');
$response->set_header('Pragma', 'no-cache');
// 更なる例
$response->set_header('Content-Language', 'en');
$response->set_header('Content-Type', 'text/html; charset=utf-8');
return $response;</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">名前はユニークであることに注意してください。同じ名前が使用された場合、上書きされます。</p>
</article>
<article>
<h4 class="method" id="method_set_headers">set_headers($headers, $replace)</h4>
<p>The <strong>set_headers</strong> メソッドは複数のカスタム HTTP ヘッダを一度に設定できます。</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>$headers</kbd></th>
<td><i>必須</i></td>
<td>ヘッダ名/値の連想配列。</td>
</tr>
<tr>
<th><kbd>$replace</kbd></th>
<td><pre class="php"><code>true</code></pre></td>
<td>デフォルトではすべてのヘッダで同じ名前の以前の値は置き換えられます。
<kbd>false</kbd> に設定すると、ヘッダは上書きされず、また、上書きできません。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Response</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$response = new Response();
// downloaded.php と呼ばれる PDF をキャッシュなしで出力します
$response->set_headers(array
'Content-Type' => 'application/pdf',
'Content-Disposition' => 'attachment; filename="downloaded.pdf"',
'Cache-Control' => 'no-cache, no-store, max-age=0, must-revalidate',
'Expires' => 'Mon, 26 Jul 1997 05:00:00 GMT');
'Pragma' => 'no-cache',
));
return $response;</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note"> ヘッダ名はユニークであり、既存の名前が使われた場合は上書きされることに注意して下さい。</p>
</article>
<article>
<h4 class="method" id="method_get_header">get_header($name = null)</h4>
<p><strong>get_header</strong> メソッドは、セットされたカスタムHTTPヘッダを取得します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>No</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><i>任意</i></td>
<td>取得したいヘッダの名称。指定しない場合にはすべてのヘッダが返却されます。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Mixed. １つのヘッダを指定した場合には文字列、すべてのヘッダが返却される場合には配列。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$response = new Response();
$response->set_header('Pragma', 'no-cache');
// 'no-cache' を返す
$header = $response->get_header('Pragma');
// array('Pragma' => 'no-cache') を返す
$header = $response->get_header();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_body">body($value = false)</h4>
<p><strong>body</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>$value</kbd></th>
<td><i>任意</i></td>
<td>セットするレスポンス本文。もし本文を与えなかった場合、現在のレスポンス本文が返ります。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Mixed. 現在のレスポンス本文、もしくは、現在のレスポンスオブジェクト。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$response = new Response();
$response->body('This is the response body');
// 'This is the response body' を返す
$body = $response->body();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_send_headers">send_headers()</h4>
<p><strong>send_headers</strong> メソッドは、セットされたヘッダおよび、HTTP ステータスコードをブラウザに出力します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>いいえ</td>
</tr>
<tr>
<th>パラメータ</th>
<td><i>なし</i></td>
</tr>
<tr>
<th>返り値</th>
<td>void</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>$response->send_headers();</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">通常は、このメソッドを手動で呼ぶ必要はありません。 Fuel はリクエストを処理する過程でこれらを自動的に行います。</p>
</article>
<article>
<h4 class="method" id="method_send">send($send_headers = false)</h4>
<p><strong>send</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>$send_headers</kbd></th>
<td><i>任意</i></td>
<td>もしtrueがセットされた場合、レスポンス本文を出力する前に、HTTP ヘッダを送信します。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>void</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// response 本文が何であっても echo する
$response->send();</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">通常は、このメソッドを手動で呼ぶ必要はありません。 Fuel はリクエストを処理する過程でこれらを自動的に行います。</p>
</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/response.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/response.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/response.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>