Response クラス

Response クラスは HTTP レスポンスとブラウザ出力を扱うメソッドを含んでいます。

ステータスヘッダを設定する

Fuel において、ステータスヘッダは "特別の" ヘッダとして扱われます。設定の仕方も、他のヘッダとは同じではありません。 コントローラの中で次のように設定します:

$response = new Response($body, 404);

ステータスヘッダと他のヘッダをセットする

$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);

forge($body = null, $status = 200, array $headers = array())

forge メソッドは、Response クラスの新しいインスタンスを生成します。

静的 はい
Parameters
Param Default Description
$body 
null
 レスポンス本文。つまりあなたがユーザに返したいレスポンス。
$status 
200
 HTTP ステータスコード。デフォルトは、200 OKです。
$headers 
array()
 レスポンスになりうる、あらゆる HTTP ヘッダ
Returns Response object
Triggers Event 'response_created' after object instantiation
Example 
// create a response object, use a View as body, and a 404 NOT FOUND status code
return Response::forge(View::forge('errors/404page'), 404);

redirect($url = '', $method = 'location', $redirect_code = 302)

redirectメソッドは、 新しいURLにリダイレクトする方法を提供します。

静的 はい
Parameters
Param Default Description
$url 
''
 リダイレクトするURL
$method 
'location'
 リダイレクト方法。'location' と 'refresh'がサポートされます。
$redirect_code 
302
 リダイレクトとして送信されるHTTPステータスコード
Returns このメソッドは、現在のスクリプトを終了し、値を返却しません。
Example 
// use a URL
Response::redirect('http://example.com/home', 'refresh');

// or use a relative URI
Response::redirect('site/about');

このメソッドは、URLのワイルドカードによる置換をサポートします。 詳しくは、Uri::segment_replace() を参照してください。

set_status($status = 200)

set_status メソッドは、ResponseオブジェクトのHTTP ステータスコードを更新します。

静的 No
Parameters
Param Default Description
$status 
200
 HTTP ステータスコード。デフォルトは、200 OK です。
Returns Current object, for chaining
Example 
$response = new Response();

// This will be a NOT FOUND response
$response->set_status(404);

set_header($name, $value, $replace)

set_header メソッドは、カスタムHTTP ヘッダをセットします。

静的 いいえ
パラメータ
パラメータ 規定値 説明
$name 必須 付け加えるヘッダ名。
$value 説明 HTTP ヘッダに付加される必要がある文字列です。
$replace 
true
 デフォルトでは同名のヘッダの値はすべて置き換えられます。false がセットされた場合は、ヘッダの書き換えはありませんし、書き換え出来ません。
返り値 void
例 
$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;

名前はユニークであることに注意してください。同じ名前が使用された場合、上書きされます。

get_header($name = null)

get_header メソッドは、セットされたカスタムHTTPヘッダを取得します。

静的 No
Parameters
Param Default Description
$name optional 取得したいヘッダの名称。指定しない場合にはすべてのヘッダが返却されます。
Returns Mixed. １つのヘッダを指定した場合には文字列、すべてのヘッダが返却される場合には配列。
Example 
$response = new Response();
$response->set_header('Pragma', 'no-cache');

// returns 'no-cache'
$header = $response->get_header('Pragma');

// returns array('Pragma' => 'no-cache')
$header = $response->get_header();

body($value = false)

body メソッドは、現在のレスポンス本文を取得、もしくは新しい値をセットすることができます。

静的 No
Parameters
Param Default Description
$value optional セットするレスポンス本文。もし本文を与えなかった場合、現在のレスポンス本文が返ります。
Returns Mixed. 現在のレスポンス本文、もしくは、現在のレスポンスオブジェクト。
Example 
$response = new Response();
$response->body('This is the response body');

// returns 'This is the response body'
$body = $response->body();

send_headers()

send_headers メソッドは、セットされたヘッダおよび、HTTP ステータスコードをブラウザに出力します。

静的 いいえ
パラメータ なし
返り値 void
例 
$response->send_headers();

通常は、このメソッドを手動で呼ぶ必要はありません。 Fuel はリクエストを処理する過程でこれらを自動的に行います。

send($send_headers = false)

sendメソッドは、出力バッファに、レスポンス本文を送ります。 (つまり出力されます)

静的 いいえ
パラメータ
パラメータ 規定値 説明
$send_headers optional もしtrueがセットされた場合、レスポンス本文を出力する前に、HTTP ヘッダを送信します。
Returns void
例 
// echo whatever the response body is
$response->send();

通常は、このメソッドを手動で呼ぶ必要はありません。 Fuel はリクエストを処理する過程でこれらを自動的に行います。