FuelPHP, a PHP 5.3 Framework Documentation

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

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 クラスの新しいインスタンスを生成します。

null

200

array()

// response オブジェクトを作成する。View を body として使い、ステータスコードは 404 Not Found とする
return Response::forge(View::forge('errors/404page'), 404);

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

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

''

'location'

302

// URL を使う
Response::redirect('http://example.com/home', 'refresh');

// 相対 URI を使うこともできる
Response::redirect('site/about');

このメソッドは、URLのワイルドカードによる置換をサポートします。Uri::segment_replace() をご覧ください。 アプリケーションの config.php で response.redirect_with_wildcards を false に設定すると、この機能を無効にできます。

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

redirect_back メソッドを使うと、現在のページに来る前のページにリダイレクトしたり、新しい URL にリダイレクトさせることができます。 前のページが自身のアプリケーションの一部ではない(つまり、ユーザーが別の Web サイトから来た)場合や URL が明示されない場合は、 アプリケーションのホームページにリダイレクトします。

''

'location'

302

// 前のページにリダイレクトする。「前のページ」がなければ、dashboard ページに移動する
Response::redirect_back('/dashboard', 'refresh');

このメソッドは、URLのワイルドカードによる置換をサポートします。Uri::segment_replace() をご覧ください。 アプリケーションの config.php で response.redirect_with_wildcards を false に設定すると、この機能を無効にできます。

set_status($status = 200)

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

200

$response = new Response();

// NOT FOUND response が返る
$response->set_status(404);

set_header($name, $value, $replace)

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

true

$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ヘッダを取得します。

$response = new Response();
$response->set_header('Pragma', 'no-cache');

// 'no-cache' を返す
$header = $response->get_header('Pragma');

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

body($value = false)

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

$response = new Response();
$response->body('This is the response body');

// 'This is the response body' を返す
$body = $response->body();

send_headers()

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

$response->send_headers();

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

send($send_headers = false)

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

// response 本文が何であっても echo する
$response->send();

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